SwaggerはWeb APIの標準記述フォーマットとして知られつつあります。標準ができるということは、それを使っていれば同じデータを使って他のフォーマットやサービスで使うことができるようになります。 すでにコード生成ライブラリなどが作られていますが、今回はSwagger向けのドキュメントを作れるSwagger Editorを紹介します。

Swagger Editorの使い方

こちらがメイン画面です。左側がエディタ、右側にその結果が表示されます。

イチから記述する他、JSONを貼り付けて読み込ませることもできます。

設定が多数用意されています。

クライアントやサーバサイドのコード生成が行えます。その結果はZipファイルでダウンロードできます。

例えばRubyのコードはこのようになります。

Swagger EditorはWeb APIのドキュメント作成はもちろん、そのままクライアントライブラリを作ったり、サーバサイドのモックアップが作れるようになっています。Swaggerに対応することで、このような展開もできるようになります。

Swagger Editorはnode/JavaScript製のオープンソース・ソフトウェア(Apache Licnese 2.0)です。

Swagger Editor swagger-api/swagger-editor: Swagger Editor