概要
Swagger-Editor は swagger.yml を作成することでツールです
UI を使って行えるので直感的に API インタフェースを定義することができます
今回はローカルの Mac に構築して swagger.yml を編集してみました
環境
- Mac OS X 10.12.3
- Docker 1.13.1
- swagger editor 2.10.4
インストール
Docker を使います
他にも Swagger が提供する Web 版を使ったり nodejs を使って npm install でインストールしたりする方法があります
- docker pull swaggerapi/swagger-editor
- docker run -p 80:8080 swaggerapi/swagger-editor
80 番ポートが使わている場合は別のホストポートにバインドしてください
起動したら http://localhost にブラウザでアクセスすれば Swagger Editor を使うことができます
使い方
swagger.yml および swagger.json が Web 経由で取得できる場合は
- File -> Import URL
で URL を指定すれば YAML ファイルを開くことができます
ローカルからはアクセスできなかったり CORS を設定していない場合などは
- File -> Import File
でローカルにある swagger.yml を指定することもできます
作成が完了したら
- File -> Download YAML
でファイルをダウンロードすることができます
あとはダウンロードしたファイルをサーバにアップロードすれば完了です
swagger generate server や swagger generate client を各言語ごとに作成する機能もあります
最後に
Swagger Editor をローカルマシンに構築してみました
Swagger UI 同様に swagger で作成したアプリが動作しているサーバじゃなくても OK です
swagger.yml or swagger.json だけを渡せれば動作させられるのは Swagger の良いところかなと思います
ちなみに停止する場合は docker run しているターミナルで Ctrl + c すれば OK です
0 件のコメント:
コメントを投稿