第3章 3scale への ActiveDocs の追加

手順

1. 管理ポータルで [your_API_name] ActiveDocs の順に移動します。3scale では、API のサービス仕様のリストが表示されます。これは最初は空です。

   サービス仕様は、必要なだけ追加することができます。通常、各サービス仕様は API のいずれか 1 つに対応しています。たとえば、3scale では、それぞれの 3scale API に仕様があります (Service Management、Account Management、Analytics、および Billing)。

2. Create a new spec をクリックします。

   新しいサービス仕様を追加する場合は、以下を指定します。

   • 名前

   • システム名

     システム名は、開発者ポータルからサービス仕様を参照するために必要です。

   • 仕様を公開するかどうかの選択。公開しない場合は、開発者ポータルで新しい仕様は利用できません。

     注記

     新しい仕様を作成しても公開しない場合は、後で希望する時期に公開することができます。

   • 使用するのは自分のみという説明の追加。

   • API JSON 仕様の追加。

     API の仕様は、OpenAPI Specification (OAS) が提案する仕様に従って生成してください。このチュートリアルでは、API 用に有効な OpenAPI Specification (OAS) 準拠の仕様がすでに用意されていることを前提としています。