第4章 3scale OpenAPI 仕様として使用する OpenAPI ドキュメントの作成方法

ActiveDocs とは OAS のインスタンスのことです。ActiveDocs を使用する場合、独自の OAS サーバーを実行したり、インタラクティブドキュメントのユーザーインターフェイスコンポーネントを扱ったりする必要はありません。インタラクティブドキュメントは、3scale のデベロッパーポータルから提供され、レンダリングされます。

3scale 2.8 では、OAS 3.0 が導入されましたが、ActiveDocs でのサポートは限定されていました。つまり、自動補完などの ActiveDocs を使用する機能の一部が完全に統合されていないため、新しいアカウントの作成時にデフォルトの 3scale は OAS 2.0 に設定されます。OAS 3.0 および ActiveDocs の詳細は、「3scale での OpenAPI Specification 3.0 の使用」 を参照してください。

すでに OAS 準拠の API 仕様がある場合は、それをデベロッパーポータルに追加できます。ActiveDocs の設定に関するチュートリアル を参照してください。

3scale では OAS 仕様をさまざまな方法で拡張し、デベロッパーポータルでのインタラクティブな API ドキュメントに必要な特定の機能に対応しています。以下に例を示します。