本ページでは、API の登録方法について説明します。
現在使用可能な API をデータサービスに登録します。 これらの各種 API は、データテーブルに基づき作成された API と併せて管理することができ、また、API Gateway に公開することができます。 現在登録できるのは、GET、POST、PUT、DELETE の各リクエスト、および JSON 形式、およびXML 形式のコンテンツタイプフォームをサポートする RESTful API のみとなります。
API 基本情報の設定
- [API Service list] 内で [Register API] をクリックすると、API の登録ページに移動します。
- API の基本情報を設定します。
各種パラメーターは以下のとおりです。- [Protocol]: HTTP のみがサポートされています。
- [Background Service Host]: API のホストを入力します。 ホストは http:// または https:// で始まる必要があります。パスを含めることはできません。
- [Background Service Path]: API のパスを入力します。 パラメーター名を角括弧で囲みます (例えば、/user/[userid])。
パスにパラメーターが定義されている場合、システムは API 登録ウィザードの 2 番目の手順で、パス内のパラメーターをリクエストパラメーターリストに自動的に追加します。
- [API Path]: [Background Service Path] のエイリアスです。 これにより、[Background Service Host] および
[Background Service Path] の API を複数の API として登録することができます。
[Background Service Path] 内で定義されているパラメーターも、[API Path] の角括弧内に定義する必要があります。
- [Request]: メソッドのオプションには、[GET]、[POST]、[PUT]、および [DELETE] があります。 各種のリクエストメソッドは、その後に続く設定項目に応じて異なります。
- [Return Type]: [JSON] または [XML] をクリックします。
- API の基本情報を入力した後、[Next] をクリックし、API パラメーターの設定ページに移動します。
API パラメーターの設定
API の基本情報を設定した後、API パラメーターを設定します。設定項目は、リクエストパラメーター、応答例、および API のエラーコードなどがあります。
- 各種リクエストパラメーター
- パラメーターのロケーション: オプションには、[Path]、[Header]、[Query]、[Body] があります。 各種リクエストごとに、オプションでパラメーターの保存先を変えることができます。 要件に応じてオプションを選択します。
- 定数パラメーター: 固定値を持ち、呼び出し元には見えないパラメーターです。 API の呼び出し中に定数パラメーターを入力する必要はありません。 ただし、バックグラウンドサービスは常に定義された定数パラメーターとその値を受信します。 パラメーターの値を固定したり、パラメーターを呼び出し元に非表示にする場合は、定数パラメーターを使用します。
- リクエストボディは、リクエストモードが POST または PUT の場合にのみ必要です。 desc によるソートが可能です。リクエストボディのコンテンツタイプには
JSON 形式 および XML形式 があります。
注 リクエストボディがリクエストボディ定義内で定義され、ボディロケーションパラメーターがリクエストパラメーター定義内で定義されている場合、ボディロケーションパラメーターは無効です。 リクエストボディが適用されます。
- API の呼び出し元が、戻りの解析コードを記述する際の参照用に、正常な場合の例、またはエラーの場合の例を入力します。
- API の呼び出しにおける、一般的なエラーと解決策を入力します。 これにより、API 呼び出し元は、各種エラーをトラブルシューティングして解決することができます。
注 呼び出し元によって API を簡単に使用できるようにするため、可能であれば、まとまった API のパラメーター情報を提供します。特にパラメーターのサンプル値、既定値、および応答例を提供してください。
API のテスト
API パラメーターの設定が完了したら、API のテストを開始します。
パラメーターを設定し、[Start Test] をクリックして、API リクエストをオンラインで送信します。 API リクエストの詳細と応答結果が右側に表示されます。 テストが失敗した場合は、エラーメッセージを注意深く読み、適切な調整を行って API を再テストします。
設定プロセスでは、標準の応答例の設定に注意する必要があります。 API をテストするとき、システムは自動的にエラー例およびエラーコードを生成します。 ただし、標準の応答例は自動的には生成されません。
テストが成功したら、[Save as Normal Response Sample] をクリックし、今のテスト結果を通常の応答サンプルとして保存します。 機密データが応答に含まれている場合、手動で編集することができます。
注
- 標準の応答例は、API 呼び出し元に重要な参照値を提供します。 可能であれば例を明記します。
- API 呼び出し遅延は、現在の API リクエストの遅延です。これは、API のパフォーマンスを評価する際に使用されます。 レイテンシが高すぎる場合は、データベースの最適化を検討してください。
API のテストが完了したら、[Finish] をクリックします。 以上により、API は正常に作成されます。