1.2. 3scale ネイティブデベロッパーポータルの変更

手順

1. 3scale 管理ポータルで、上部のコンテキストセレクターを展開し、Audience をクリックします。
2. 左側のナビゲーションツリーで Developer Portal を展開し、Content をクリックします。

3. Root で、デベロッパーポータルのランディングページの内部タイトルである Homepage をクリックし、デベロッパーポータルの開発バージョンに表示されるランディングページの見出しを変更します。

   1. Page 'Homepage' で、ランディングページをレンダリングするコードが表示されるまでスクロールダウンします。

   2. 5 行目で、

      <h1>Echo API</h1>

      上記を以下のように変更します。

      <h1>Petstore API</h1>

   3. ページの下部で、Publish をクリックします。
   4. 左側のナビゲーションツリーの Developer Portal の下で、Visit Portal をクリックしてデベロッパーポータルの開発バージョンを表示し、現在ランディングページ見出しが Petstore API であることを確認します。
4. デベロッパーポータルの開発バージョンのままで、トップメニューバーの Documentation をクリックします。デベロッパーポータルに、Echo API の ActiveDocs が表示されます。
5. 3scale 管理ポータルに戻り、Developer Portal > ActiveDocs を選択して Echo API のエントリーを表示します。3scale では、Echo API を定義する OpenAPI ドキュメントが提供されます。3scale はこの OpenAPI ドキュメントを使用して Echo API の ActiveDocs を表示します。

6. Swagger Petstore API を定義する OpenAPI ドキュメントをインポートします。

   1. https://petstore.swagger.io/v2/swagger.json にアクセスし、JSON コンテンツをクリップボードにコピーします。
   2. 3scale 管理ポータルに戻り、Developer Portal > ActiveDocs を選択します。
   3. ActiveDocs ページで、Create a new spec をクリックします。
   4. Name フィールドに Petstore を入力します。
   5. Publish? を選択します。
   6. API JSON Spec ウィンドウをクリックし、クリップボードにコピーから Swagger Petstore JSON コンテンツを貼り付けます。
   7. ページの下部にある Create Spec をクリックします。3scale に、Petstore API の ActiveDocs が表示されます。
   8. 左側のナビゲーションツリーで、Developer Portalの下にある ActiveDocs をクリックします。Echo API の後に、Petstore の 2 番目のエントリーがあります。

7. デベロッパーポータルに Petstore API のドキュメントを表示します。

   1. 左側のナビゲーションツリーで、Developer Portalの下にある Content をクリックします。
   2. Root で、デベロッパーポータルのドキュメントページの内部タイトルである Documentation をクリックします。

   3. Page 'Documentation' で、ドキュメントのランディングページをレンダリングするコードが表示されるまでスクロールダウンします。5 行目は、デベロッパーポータルが ActiveDocs を表示する OpenAPI ドキュメントを識別します。5 行目のデフォルト値は、以下のとおりです。

      {% assign spec = provider.api_specs.first %}

      デフォルトの動作では、デベロッパーポータルはDeveloper Portal > ActiveDocsページの最初のエントリーの ActiveDocs を表示します (初期は Echo API)。以下の図では、5 行目がハイライトされています。

      

   4. 5 行目を変更し、provider.api_specs.first を変更し、ActiveDocs ページの 2 番目のエントリーを識別するインデックスを追加します。

      {% assign spec = provider.api_specs[1] %}

      デフォルトの動作では、デベロッパーポータルは 1 つの OpenAPI ドキュメントの ActiveDocs のみを表示します。複数の OpenAPI ドキュメントの ActiveDocs を表示するには、この簡単な変更以外に Documentation ページを変更する必要があります。

   5. ページの下部で、Publish をクリックします。
8. 左側のナビゲーションツリーの Developer Portal の下で、Visit Portal をクリックしてデベロッパーポータルの開発バージョンを表示します。
9. トップメニューバーで Documentation をクリックし、Swagger Petstore のドキュメントを参照してください。