第2章 3scale への仕様の追加
本章では、API に ActiveDocs を設定する手順について説明します。
3scale は、API のインタラクティブドキュメントを作成するためのフレームワークを提供します。
OpenAPI Specification (OAS) を使用することで、API に機能的なドキュメントを設定することができます。これは、開発者が API を調べ、テストを行い、統合するのに役立ちます。
2.1. ActiveDocs のサービス仕様への移動
管理ポータルで [your_API_name] → ActiveDocs の順に移動します。これにより、API のサービス仕様のリストが表示されます (初期段階は空)。
サービス仕様は、必要なだけ追加することができます。通常、各サービス仕様は API のいずれか 1 つに対応しています。たとえば、3scale では、それぞれの 3scale API に仕様があります (Service Management、Account Management、Analytics、および Billing)。
