すべてのプロダクト
Search

このプロダクト

    DataWorks:API の登録

    ドキュメントセンター

    DataWorks:API の登録

    最終更新日:Mar 18, 2025

    既存の API を DataService Studio に登録して、API を一元的に公開および管理できます。たとえば、API の呼び出し情報と呼び出しログを表示したり、API タグとバージョンを管理したりできます。このトピックでは、既存の API を登録および構成する方法について説明します。

    API の登録

    使用可能な API がない場合は、API を作成する必要があります。 API の作成方法の詳細については、「コードレス UI を使用した API の作成」をご参照ください。

    1. DataService Studioページの [サービス開発] ペインで、新建 アイコンにポインターを移動し、[APIの作成] > [APIの登録] を選択します。

      目的のビジネスプロセスを展開し、[API] を右クリックして、[API の作成] > [API の登録] を選択することもできます。

    2. [API の登録] ダイアログボックスで、パラメーターを構成します。次の表に、パラメーターについて説明します。

      注册API

      パラメーター

      説明

      API 名

      API の名前。名前は 4 ～ 50 文字で、文字、数字、アンダースコア (_) を使用できます。名前は文字で始める必要があります。

      API パス

      API が保存されるパス。例: /user。

      説明

      パスは最大 200 文字で、文字、数字、スラッシュ (/)、アンダースコア (_)、ハイフン (-) を使用できます。パスはスラッシュ (/) で始める必要があります。

      プロトコル

      API で使用されるプロトコル。有効な値: HTTP および HTTPS。

      HTTPS を使用して API を呼び出す場合は、API を API Gateway に公開した後、API Gateway コンソールで、API が属する API グループに独立ドメイン名をバインドする必要があります。また、API Gateway コンソールに SSL 証明書をアップロードする必要があります。詳細については、「API 操作で HTTPS を有効にする」をご参照ください。

      リクエストメソッド

      API で使用されるリクエストメソッド。有効な値: GET、POST、PUT、DELETE。

      レスポンスタイプ

      API から返されるデータの形式。有効な値: JSON および XML。

      表示範囲

      API の可視スコープ。有効な値:

      • ワークスペース: API は現在のワークスペースのすべてのメンバーに表示されます。

      • プライベート: API は所有者のみが表示でき、API の権限を他のメンバーに付与することはできません。

        説明

        このパラメーターを [プライベート] に設定すると、現在のワークスペースの他のメンバーは API リストで API を表示できません。

      ラベル

      API に追加するタグ。[ラベル] ドロップダウンリストからタグを選択します。

      説明

      タグは最大 20 文字で、文字、数字、アンダースコア (_) を使用できます。 1 つの API に最大 5 つのタグを追加できます。

      説明

      API の説明。説明は最大 2,000 文字です。

      保存先フォルダー

      API を保存するフォルダー。

    3. [OK] をクリックします。

    API の構成

    1. 登録済み API の名前をダブルクリックします。API の構成タブで、[バックエンドサービスの定義] セクションのパラメーターを構成します。次の表に、パラメーターについて説明します。

      后端服务定义

      パラメーター

      説明

      ホスト

      登録済み API のホスト。ホスト名は http:// または https:// で始める必要があり、パスを含めることはできません。

      説明

      たとえば、API の URL が http://xxx-cn-xxx.alicloudapi.com/user/info の場合、このパラメーターを http://xxx-cn-xxx.alicloudapi.com に設定できます。ビジネス要件に基づいてこのパラメーターを構成できます。// ホスト名にはパスを含めないでください。例: http://example.com

      パス

      登録済み API のパス。パスには、角かっこ [] で囲まれたパラメーターを含めることができます。例: /user/[userid]。

      次のステップでは、[パス] パラメーターで定義されたパラメーターがリクエストパラメーターリストに自動的に追加されます。

      説明

      たとえば、API の URL が http://xxx-cn-xxx.alicloudapi.com/user/info の場合、このパラメーターを /user/info に設定できます。ビジネス要件に基づいてこのパラメーターを構成できます。// パラメーターを角かっこで囲みます。例: /users/[userId]

      バックエンドサービスのタイムアウト

      バックエンドサービスのタイムアウト期間。

    2. [リクエストパラメーターの定義] セクションで、ビジネス要件に基づいてパラメーターを構成します。 次の表に、パラメーターについて説明します。

      请求参数定义

      パラメーターまたはセクション

      説明

      リクエストパラメーター

      このセクションでは、[パラメーターの追加] をクリックして、API のリクエストパラメーターを追加できます。

      リクエストパラメーターごとに、[パラメーターの位置] フィールドを QUERY、HEAD、または BODY に設定できます。[パラメーターの位置] フィールドの有効な値は、API で使用されるリクエストメソッドによって異なります。表示されている有効な値から値を選択します。

      定数パラメーター

      定数パラメーターは固定値を持ち、API 呼び出し元には表示されません。API 呼び出し中に定数パラメーターを指定する必要はありません。ただし、バックエンドサービスは、定義された定数パラメーターとその値を各 API 呼び出しで受信します。

      パラメーターの値を修正したり、API 呼び出し元に対してパラメーターを非表示にする必要がある場合は、定数パラメーターを使用できます。

      リクエスト本文の説明

      このパラメーターは、[リクエストメソッド] パラメーターを POST または PUT に設定した場合にのみ表示されます。

      [リクエスト本文の説明] パラメーターには、JSON または XML 形式で本文の説明を入力できます。これにより、API 呼び出し元がリクエスト本文の形式を判断するためのリクエスト本文の例を提供できます。

    3. [レスポンスコンテンツの定義] セクションで、[正しいレスポンスの例] パラメーターと [エラーレスポンスの例] パラメーターを構成します。レスポンスの例は参考用です。API 呼び出し元は、例に基づいて API のレスポンスを解析するためのコードを記述できます。

    4. [エラーコードの定義] セクションで、[エラーコード]、[エラーメッセージ]、[解決策] パラメーターを構成して、エラーコードを定義します。この情報は、API 呼び出し元がエラーの原因を特定するのに役立ちます。

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

      API が構成されたら、API をテストできます。詳細については、「API のテスト」をご参照ください。

      テストが成功したら、右上隅の [送信] をクリックします。

      API 構成タブの右側ナビゲーションペインで、[バージョン] をクリックします。公開する API バージョンを見つけて、[アクション] 列の [公開申請] をクリックして、申請ページに移動します。デフォルトの申請タイプ [データサービス API の公開] を使用し、[申請理由] フィールドに申請理由を入力します。次に、[権限の申請] をクリックして申請を送信します。

      説明

      DataWorks 承認センターで承認ポリシーを定義した場合、API を公開するには API を承認する必要があります。詳細については、「承認センター」をご参照ください。

      API が公開されると、API が呼び出されたときに DataService Studio のリソースグループの構成が有効になります。

      [サービス開発] タブの左側ナビゲーションペインで、登録済み API を見つけて管理できます。たとえば、API の複製や削除ができます。[サービス管理] タブで、公開済み API を見つけて、公開済み API の詳細を表示できます。詳細については、「API の表示、削除、移動、複製、複数の API に対するバッチ操作の実行、コード検索機能を使用した API の検索」をご参照ください。