Swaggerをベースに現在策定が進められているのがOpen APIです。策定されれば多くのソフトウェアがそのフォーマットに対応することでしょう。そうなればAPIエコノミーがさらに広がっていくはずです。 今回紹介するOpen API designerはOpen APIのWebブラウザ上でデザインできるソフトウェアです。

Open API designerの使い方

まだ仕様が定まっていないこともあり、バージョンはSwagger 2.0となっています。

Schemes、Consumes、Produces、Pathsなどをそれぞれ追加できます。

追加した後は表示された項目に合わせて入力していきます。そうすると右側のJSONも更新されます。

複雑なOpen APIドキュメントもさくさくと作れるでしょう。

Swaggerドキュメントの多くはシステムから自動生成されるものです。しかし、時に手作業で書かなければならないことがあります。そんな時にOpen API designerを使ってウィザード的に進めていくことができれば、より理想的な形式で書き上げられることでしょう。Swaggerフォーマットの練習にも最適です。

Open API designerはHTML5/JavaScript製のオープンソース・ソフトウェア（MIT License）です。

Open API designer apinf/open-api-designer: Design interface for creating Open API (Swagger) specification files