4.3. OAS 仕様に関する補足情報

ドキュメントを OAS Petstore のドキュメント のようにしたい場合は、関連の Petstore swagger.json ファイルのような Swagger 準拠の仕様を作成する必要があります。この仕様をそのまま使用して、ActiveDocs をテストすることができます。ただし、これは実際の API ではないことに注意してください。

OAS は、JSON でエンコードされたハッシュにマッピングするリソース宣言に依存します。Petstore swagger.json ファイルを例として使用し、各オブジェクトについて説明します。

オブジェクトではないパラメーターは、プリミティブデータタイプを使用します。Swagger では、プリミティブデータ型は JSON スキーマドラフト 4 でサポートされるタイプに基づきます。プリミティブデータ型には ファイル もありますが、3scale では API エンドポイントで CORS が有効な場合にのみ使用されます。CORS を有効にすると、アップロードが拒否される api-docs ゲートウェイを通過しません。

現在、OAS は以下の データタイプ をサポートしています。