Swagger Specification(OpenAPI Specification)の要素では表現力が足りない場合の拡張方法
はじめに
「Swagger Specification(OpenAPI Specification)では要素たりない。でも、勝手な名前で要素を追加すると、Swagger Editorがエラーを出力するし…」と困っていたのですが、要素を追加するための仕様があることを人に教えてもらいました。
なので、忘れないようにめも。
環境
- OpenAPI Specification(fka Swagger RESTful API Documentation Specification) Version 2.0
拡張するするための仕様について
以下に拡張するための仕様の説明が存在します。
- OpenAPI Specification | Swaggerの「Patterned Objects」の項
- Swagger Specificationの「Specification Extensions」の項
一言でいうと「x-」から始まる要素を作って良いとのこと。
最初はJSON Schemaに拡張の仕様がないか探していましたが、そちらの方では拡張の仕様を見つけられませんでした。
