DataWorks:外部 API サービスの登録

API の登録

API がない場合は、まず API を生成する必要があります。詳細については、「コードレス UI での API の生成」をご参照ください。

1. [サービス開発] ページで、 アイコンをクリックし、[新しい API] > [API の登録] を選択します。

   または、ビジネスプロセスを開き、[API] を右クリックして、[新しい API] > [API の登録] を選択することもできます。

2. [API の登録] ダイアログボックスで、パラメーターを設定します。

   

   パラメーター	説明
   宛先フォルダ	API が格納されるフォルダです。テキストをクリックしてフォルダを選択します。 重要 最初に宛先フォルダを選択してください。フォルダを選択できない場合は、ビジネスプロセスを作成してください。
   API 名	API のカスタム名です。名前は、API ゲートウェイグループおよびワークスペース内で一意である必要があります。
   API パス	API が格納されるパスです。例：/user。
   プロトコル	サポートされているプロトコルは HTTP と HTTPS です。 HTTPS 経由で API を呼び出す場合は、API をゲートウェイに公開する必要があります。次に、API Gateway コンソールで独立ドメイン名をバインドし、SSL 証明書をアップロードします。詳細については、「HTTPS のサポート」をご参照ください。
   リクエストメソッド	サポートされているメソッドは GET、POST、PUT、DELETE です。
   戻り値のタイプ	サポートされているフォーマットは JSON と XML です。
   表示範囲	範囲は ワークスペース または プライベート に設定できます。 ワークスペース：API は現在のワークスペースのすべてのメンバーに表示されます。 プライベート：API はそのオーナーにのみ表示されます。API の権限を他のメンバーに付与することはできません。 説明 表示範囲をプライベートに設定した場合、API はディレクトリツリー内で自分にのみ表示されます。ワークスペース内の他のメンバーには表示されません。
   ラベル	[ラベル] リストからタグを選択します。
   説明	API の簡単な説明です。説明は 2,000 文字を超えることはできません。

API の設定

1. 登録した API をダブルクリックして設定ページを開きます。[バックエンドサービスの定義] セクションで、パラメーターを設定します。

   

   パラメーター	説明
   バックエンドサービスホスト	登録する API サービスのホストです。ホストは http:// または https:// で始まり、パスを含めることはできません。 説明 例：ご利用の API サービスの URL が http://xxx-cn-xxx.alicloudapi.com/user/info の場合、バックエンドサービスホストを http://xxx-cn-xxx.alicloudapi.com に設定できます。このパラメーターは、ご利用の API サービスの実際のパスに基づいて設定してください。
   バックエンドサービスパス	登録する API サービスのパスです。パスには、[] で囲まれたパラメーター (例：/user/[userid]) を含めることができます。 パスにパラメーターを設定すると、システムは API 登録ウィザードの次のステップで、パスパラメーターをリクエストパラメーターリストに自動的に追加します。 説明 例：ご利用の API サービスの URL が http://xxx-cn-xxx.alicloudapi.com/user/info の場合、バックエンドサービスパスを /user/info に設定できます。このパラメーターは、ご利用の API サービスの実際のパスに基づいて設定してください。
   バックエンドタイムアウト	バックエンドサービスのタイムアウト期間です。

2. [リクエストパラメーターの定義] セクションで、パラメーターを設定します。

   

   パラメーター	説明
   リクエストパラメーター	[パラメーターの追加] をクリックして、API のリクエストパラメーターを設定します。 [パラメーターの位置] は QUERY、HEAD、PATH、または BODY に設定できます。リクエストメソッドによってサポートされるパラメーターの位置は異なります。必要に応じて、利用可能なオプションから位置を選択してください。
   定数パラメーター	API 呼び出し元には表示されない固定値を持つパラメーターです。API を呼び出す際に定数パラメーターを渡す必要はありません。ただし、バックエンドサービスは常にここで設定した定数パラメーターとその値を受け取ります。 これは、パラメーターの値を固定し、API 呼び出し元から非表示にする必要がある場合に役立ちます。
   リクエストボディの定義	このパラメーターは、リクエストメソッドが POST または PUT の場合にのみ表示されます。 JSON または XML 形式でボディの説明を入力できます。これは、API 呼び出し元が参照するためのリクエストボディの例として機能します。

3. [応答内容の定義] セクションで、[正常な応答の例] と [エラー応答の例] を入力します。これにより、API 呼び出し元は API 応答を解析するコードを記述しやすくなります。

4. [エラーコードの定義] セクションで、API 呼び出しの [エラーコード]、[エラーメッセージ]、[解決策] を入力します。これにより、API 呼び出し元はエラーの原因を特定しやすくなります。

5. ツールバーの アイコンをクリックして API を保存します。