SwaggerからOpenAPI Specificationへ。コンバーターを試す
最近の記事
2017/10/20
ついにOpenAPI Specificationがリリースされました。以前紹介した通り、文書構造が分かりやすくなったのが一番の特徴です。できることとしてはそれほど大きくは変わりません。
そこでこれまでSwagger.jsonで作ってきた内容をOpenAPI Specificationのフォーマットに整えるニーズが出てきます。手作業でやるのはとても大変なので、まずはコンバーターを使ってみましょう。それがMermade Swagger 2.0 to OpenAPI 3.0.0 converterです。オープンソース・ソフトウェアとして作られています。
使い方
使い方としてはテキストエリアにSwagger.json（YAMLでも可）を貼り付けるか、Swagger.jsonをアップロードとして指定します。なお、バリデーションだけ行うこともできます。
内容を変換するとYAML形式で表示されます。
一番最初の行に openapi: 3.0.0 と書いてあるのが一番の特徴でしょう。
リクエストパラメータとレスポンスパラメータが同じ形式になったこと、リファレンスが統一されたのが利便性を向上させてくれることでしょう。
OpenAPI Specification対応について
現在、各ソフトウェアでOpenAPI Specification対応が進められています。その一つとしてSwagger Editorがあります。こちらは従来のSwagger 2.0はもちろん、OpenAPI Specificationにも対応しています。
今後、対応ソフトウェアはどんどん増えていくでしょう。また、今後はSwagger系サービスを作る際にはOpenAPI Specificationを基準に開発するのが良さそうです。