API をテストした後、API を API Gateway に公開して、ライフサイクル全体を管理できます。たとえば、API の設計、開発、テスト、公開、監視、管理、および非公開化を行うことができます。また、API を Alibaba Cloud Marketplace に公開して販売することもできます。これにより、データの価値を実現し、効率的な方法でクローズドループビジネスを形成できます。このトピックでは、API を API Gateway および Alibaba Cloud Marketplace に公開する方法について説明します。
前提条件
公開する API がテスト済みであること。詳細については、「開発中の API をテストする」をご参照ください。
API Gateway がアクティブ化されていること。
DataWorks と API Gateway のネットワークアーキテクチャの制限により、API Gateway インスタンスを購入する際に、[タイプ] パラメータを標準インスタンスにのみ設定できます。 種類 パラメータを VPC 統合インスタンスに設定することはできません。
背景情報
API Gateway は、API の公開、管理、運用・保守、販売などの API ライフサイクル管理サービスを提供します。API Gateway は、権限管理、速度制限、アクセス制御などのサービスも提供します。API Gateway は、マイクロサービスの集約、フロントエンドとバックエンドの分離、システムの統合、パートナーや開発者への機能とデータの提供に使用できる、シンプルで高速、費用対効果が高く、低リスクのサービスを提供します。DataService Studio で API を公開すると、API は API Gateway に公開されます。その後、API Gateway は API の呼び出しに使用される URL を自動的に生成します。API Gateway の詳細については、「API Gateway とは」をご参照ください。
DataService Studio では、API を Alibaba Cloud Marketplace に公開することもできます。詳細については、「API を Alibaba Cloud Marketplace に公開する」をご参照ください。
API を API Gateway に公開する
[dataservice Studio] ページに移動します。
DataWorks コンソール にログオンします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションウィンドウで、 を選択します。表示されたページで、ドロップダウンリストから目的のワークスペースを選択し、[dataservice Studio に移動] をクリックします。
[サービス開発] ウィンドウのビジネスプロセスセクションで、公開する API を見つけ、API 名をダブルクリックします。API の構成タブで、上部のツールバーの [送信] をクリックします。
説明テスト済みの API のみを送信できます。API のテスト方法については、「API をテストする」をご参照ください。
API が送信されると、ページの上部にプロンプトメッセージが表示され、API バージョンが自動的に生成されます。 [バージョン] タブで、送信された API の現在のバージョン情報 (API ステータスなど) を表示できます。
API を公開するための申請を送信します。
API 構成タブの右側のナビゲーションウィンドウで、[バージョン] をクリックします。公開する API バージョンを見つけ、[アクション] 列の [公開をリクエスト] をクリックして、API バージョンを公開します。
デフォルトのアプリケーションタイプ「データサービス API の公開」を使用し、[申請理由] フィールドに申請理由を入力します。次に、[権限を申請] をクリックして申請を送信します。
説明DataWorks 承認センターで承認ポリシーを定義した場合、API を公開するには、API が承認される必要があります。詳細については、「承認センター」をご参照ください。
申請が承認されるまで待ちます。
申請を送信した後、レビュー担当者が DataWorks 承認センターの承認ポリシーに基づいて承認を完了した後にのみ、API を公開できます。レビュー担当者は、DataWorks [承認センター] の [処理されるリクエスト] ページで申請の詳細を表示し、申請を処理できます。
説明申請が承認されると、[バージョン] タブの API のステータスが [リクエストされる] から [公開可能] に変わります。
API を公開します。
申請が承認されたら、API 構成タブの右側のナビゲーションウィンドウで [バージョン] をクリックします。承認レコードを見つけ、[アクション] 列の [公開] をクリックします。
DataService Studio ページで API が公開されると、DataWorks は、API が属するビジネスプロセスの関連付けられた API グループに基づいて、API を API Gateway の関連 API グループに公開します。ビジネスプロセスに関連付けられている API グループを表示するには、DataService Studio ページの [サービス開発] ウィンドウでビジネスプロセスを見つけ、ビジネスプロセスの名前を右クリックして、[属性の変更] を選択します。API が公開された後、API Gateway コンソールに移動し、 を選択して、公開された API に関する情報を表示できます。
API が公開された後、API Gateway コンソールに移動して API に関する情報を表示したり、API の速度制限とアクセス制御の設定を構成したりできます。
アプリケーションで API を呼び出す場合は、アプリケーションを作成し、API Gateway コンソールでアプリケーションに API を使用する権限を付与します。次に、AppKey と AppSecret を使用して API リクエストに署名することで、アプリケーションで API を呼び出します。詳細については、「API 呼び出しの例」をご参照ください。API Gateway は、主要なプログラミング言語用の SDK も提供しています。SDK を使用して、API をアプリケーションに統合できます。詳細については、「SDK をダウンロードして使用する」をご参照ください。
API を Alibaba Cloud Marketplace に公開する
Alibaba Cloud Marketplace の API セクターは、金融、AI、E コマース、交通地理、生活サービス、企業管理、公共事業のカテゴリで数千の API プロダクトを提供しています。Alibaba Cloud Marketplace は、データを収益化できるプラットフォームを提供します。
DataService Studio で作成または登録された API を API Gateway に公開した後、数回クリックするだけで API を Alibaba Cloud Marketplace に公開できます。これは、企業の収益を上げる簡単な方法です。
API を Alibaba Cloud Marketplace に公開する前に、独立系ソフトウェアベンダー（ISV）として Alibaba Cloud Marketplace に登録する必要があります。
企業ユーザーのみが ISV として Alibaba Cloud Marketplace に登録できます。
Alibaba Cloud Marketplace の ISV ポータル にログオンします。
左側のナビゲーションウィンドウで、[上場] をクリックします。 [商品マネージャー] ページが表示されます。
[プロダクトの作成] をクリックします。
[アクセス情報] ステップで、ビジネス要件に基づいてパラメータを構成し、[次へ] をクリックします。次に、プロンプトに従って他の手順を完了します。
後続の操作
API を公開した後、他のワークスペースに API を呼び出す権限を付与できます。また、ワークスペースに呼び出し権限が付与されている API を表示して、データ共有を実装することもできます。詳細については、「API を呼び出す権限を付与する」をご参照ください。
API が公開され、API を呼び出す権限が付与された後、簡易認証または署名認証方式を選択して API を呼び出すことができます。簡易認証を選択した場合は、リクエストヘッダーに AppCode を追加する必要があります。署名認証を選択した場合は、リクエストヘッダーに AppKey と AppSecret を追加する必要があります。詳細については、「API を呼び出す」をご参照ください。