ステップ 6: API を公開する

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示します。

このステップでは、以下の手順を行って API をポータルに公開します。

1. 仕様から API プロキシを作成する
2. API プロダクトを作成する
3. API をポータルに公開する

ステップ 1: 仕様から API プロキシを作成する

API を記述する OpenAPI 仕様から API プロキシを作成します。

OpenAPI 仕様から API プロキシを作成するには:

1. Apigee UI で、左側のナビゲーション バーから [Develop] > [API Proxies] を選択して、[API Proxies] ページを開きます。

2. [Create New] をクリックします。
   

   [Create Proxy] ウィザードが開いたら、作成する API プロキシのタイプを選択します。

3. [Reverse Proxy（最も一般的）] で [Use OpenAPI Spec] をクリックします。

   [Use OpenAPI Spec] ダイアログが表示されます。

4. 次の URL をコピーして、[URL] タブの [OpenAPI Spec URL] に貼り付けます。

   https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

5. [Select] をクリックします。
   [Create Proxy] ウィザードが開き、[OpenAPI 仕様] の値を使用して [Proxy details] ページがあらかじめ入力されます。

   

6. [Description] フィールドを次のように編集します。API proxy for hello world.

7. [Next] をクリックします。

8. [Policies] ページで、次の操作を行います。

   • [Security: Authorization] で [Pass through（認証なし）] を選択します。
   • [Security: Browser] で、[Add CORS headers] を選択します。

   

9. [Next] をクリックします。

10. [Flows] ページですべてのオペレーションが選択されていることを確認して、[Next] をクリックします。
    

11. [Summary] ページで、[Optional Deployment] でデプロイする環境を選択します。

    

12. [Create and deploy] をクリックします。

[サマリー] ページに、新しい API プロキシが正常に作成され、選択した環境にデプロイされたことを示す確認応答が表示されます。

---

ステップ 2: API プロダクトを作成する

API コンシューマに公開する API リソースを含む API プロダクトを作成します。

API プロダクトを作成するには:

1. Apigee UI で、左側のナビゲーション バーから [Publish] > [API Products] を選択して、[API Products] ページを開きます。
2. [+Create] をクリックします。
   [Product] ページが表示されます。
3. [Product Details] に、API プロダクトの詳細を入力します。
   注: デフォルトでは、[Display Name] フィールドと [Description] フィールドは、API プロダクトを公開する際にポータルに表示されます。この値は、ステップ 3: API をポータルに公開するで編集できます。
   

   フィールド	値
   名前	Hello World
   表示名	Hello World
   説明	シンプルな Hello World の例
   環境	API プロキシがデプロイされる環境を選択します。
   アクセス	Public
   接続リクエストの自動承認	有効
   割り当て	（空白のまま）
   許可済みの OAuth Scopes	（空白のまま）

4. [Operations] セクションで、[ADD AN OPERATION] をクリックして、API プロダクトに追加するオペレーションを指定します。
5. [Source] で [API proxy] をクリックし、プルダウンから [Mock-Target-API] を選択します。
6. [Operation] の [Path] フィールドに、スラッシュ（/）を入力します。他のフィールドは無視します。
7. [Save] をクリックして、オペレーションを保存します。
8. [追加に関する操作] ダイアログが表示されます。
9. [追加] をクリックします。
10. [Save] をクリックします。

---

ステップ 3: API をポータルに公開する

API をポータルに公開して、お客様が内容を理解して使用できるようにします。

API をポータルに公開する

1. Apigee UI で、ポータルの API ページに移動します。
   1. 左側のナビゲーション バーで [Publish] > [Portals] を選択します。
   2. [My first Portal] の行をクリックしてポータルを開きます。
   3. [API Catalog] をクリックして API ページを表示します。
2. [+] をクリックします。
3. [Add an API product to the catalog] ダイアログで [Hello World] を選択し、[Next] をクリックします。
4. [API の詳細] で、次のオプションを構成します。
   • [Published (catalog in list)] を選択して、API をポータルに公開します。
   • [ディスプレイ画像] の場合:
     1. [画像を選択] をクリックします。
     2. [イメージを選択] ダイアログで、既存のイメージのリストから [home-background.jpg] をクリックします。
     3. [Select] をクリックします。
     4. 画像をプレビューし、[Select] をクリックします。
   • [カテゴリ] に「Get Started」と入力して、Enter キーを押します。

   その他の値はすべてデフォルトのままにします。

   

5. [API ドキュメント] で、OpenAPI 仕様のスナップショットから API リファレンス ドキュメントを自動生成します。
   1. [OpenAPI document] を選択します。
   2. [Select Document] をクリックします。
   3. [Import from a URL] タブを選択します。
   4. [Spec name] フィールドに「helloworld」と入力します。
   5. 次の URL をコピーして [URL] フィールドに貼り付け、Enter キーを押します。

      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

   6. [Select] をクリックします。

   

6. [Save] をクリックします。

API リファレンス ドキュメントを表示するには

1. Apigee UI で [Live Portal] をクリックして、ライブポータルで変更を表示します（または、ライブポータルがすでに別のタブで開いている場合は更新します）。
2. ライブポータルで、以下の手順を実行します。
   a. 上部のナビゲーション バーにある [APIs] をクリックして、公開された API を表示します。
   b. Hello World カードをクリックして、API リファレンス ドキュメントを表示します。
   c. API を試してみましょう。

---

お疲れさまでした。チュートリアルが完了しました。詳細については、Apigee ポータルのドキュメントをご覧ください。