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

API の登録

API がない場合は、まず API を作成してください。詳細については、「データソースから API を作成する (API Gateway)」をご参照ください。

1. サービス開発 ページで、 アイコンをクリックし、Create API > Register API を選択します。

   または、関連するビジネスプロセスを開き、API を右クリックして、Create API > Register API を選択することもできます。

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

   

   パラメーター	説明
   Location	API が保存されるディレクトリです。 重要 最初に保存先フォルダを選択することを推奨します。選択可能なフォルダがない場合は、まずビジネスプロセスを作成してください。
   API Name	API Gateway グループおよびワークスペース内で一意の API 名です。
   APIPath	API のパスです。例：/user。
   契約	サポートされているプロトコル：HTTP および HTTPS。 HTTPS 経由で API を呼び出す必要がある場合は、API を API Gateway に公開し、API Gateway コンソールで専用ドメイン名をバインドして、SSL 証明書をアップロードする必要があります。詳細については、「HTTPS の有効化」をご参照ください。
   Request Method	サポートされているメソッド：GET、POST、PUT、DELETE。
   Response Type	サポートされているタイプ：JSON および XML。
   目に見える範囲	選択可能なオプションは Work space と Private です。 Work space：API は現在のワークスペースのすべてのメンバーに表示されます。 Private：API は API の所有者にのみ表示されます。非公開 API は権限付与をサポートしていません。 説明 表示範囲をプライベートに設定した場合、API はディレクトリツリー内で自分にしか表示されず、他のワークスペースメンバーは表示できません。
   Tag	Tag リストからタグを選択します。
   Description	API の説明です。最大 2,000 文字まで入力できます。

API の設定

1. 登録した API をダブルクリックして設定ページを開きます。Define Backend Service セクションで、次のパラメーターを設定します。

   

   パラメーター	説明
   Host	バックエンドサービスのホストです。値は http:// または https:// で始まり、パスを含んではいけません。 説明 例えば、サービス URL が http://xxx-cn-xxx.alicloudapi.com/user/info の場合、バックエンドサービスのホストを http://xxx-cn-xxx.alicloudapi.com に設定できます。このパラメーターは、実際のサービス URL に基づいて設定してください。
   Path	バックエンドサービスのパスです。パスパラメーターを角括弧 ([]) で含めることができます。例：/user/[userid]。 パスにパラメーターを設定すると、システムはそれらを自動的にリクエストパラメーターリストに追加し、パラメーターの位置を PATH に設定します。 説明 例えば、サービス URL が http://xxx-cn-xxx.alicloudapi.com/user/info の場合、バックエンドサービスのパスを /user/info に設定できます。このパラメーターは、実際のサービス URL に基づいて設定してください。
   Back-end Service Timeout	バックエンドサービスのタイムアウト期間です。

2. Define Request Parameters セクションで、次のパラメーターを設定します。

   

   パラメーター	説明
   Request Parameters	Add をクリックして、API のリクエストパラメーターを設定します。 Parameter Position は QUERY、HEAD、PATH、または Body に設定できます。選択可能な位置は、選択したリクエストメソッドによって異なります。要件に応じて位置を選択してください。
   Constant Parameters	固定パラメーターは固定値を持ち、API 呼び出し元には表示されません。呼び出し元はこれらのパラメーターを渡す必要はありませんが、バックエンドサービスは常に設定された値でそれらを受け取ります。
   [リクエストボディの定義]	このセクションは、リクエストメソッドが POST または PUT の場合にのみ表示されます。 JSON または XML 形式でリクエストボディのサンプルを提供し、呼び出し元にリクエストの構造を示すことができます。

3. Define Response Content セクションで、Correct Response Example と Error Response Example を提供します。これらの例は、API 呼び出し元がレスポンスのフォーマットを理解し、解析コードを記述するのに役立ちます。

4. Error Code Definition セクションで、潜在的なエラーに対する Error Code、Error message、および Solution を定義します。この情報は、API 呼び出し元が問題を自己診断し解決するのに役立ちます。

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