趣旨 †
SWAGGERのメモです。
SWAGGER †
モデルファーストなAPI開発。
RESTful な APIの仕様書とインタフェースを連動して記述できる
仕様書を書いて、その場でテストするツールも連動していて便利
また、swageer-edit使うと、各言語用に設定ファイルとかも吐き出してくれる
標準を目指している。 †
Open API InitiativeというREST APIの標準を決めようとしている団体があり、それはswaggerベースで書かれている。
本家URL †
インストール前提 †
nodeがインストールしてある前提
設定ファイル †
swagger.jsonまたはswagger.yaml
ツール †
swaggerの定義を読み込む †
Swagger Core
コマンドライン †
Swagger Codegen
ブラウザでドキュメントを生成 †
Swagger UI
APIの仕様が一覧で見れる公式のデモがある。
ブラウザからjsonなどのの構文チェック †
Swagger Editor
公式サイトにデモがある http://editor.swagger.io/#/
swaggerの設定ファイル(swagger spec)の書き方 †
Swagger Editorを使って書いていく感じ
参考URL †
swaggerの基礎。swaggerの設定ファイルの書き方とか
ツールを触ってみて概要をわかるようになるのが目的な感じの内容
Last-modified: 2016-12-12 (月) 09:33:47 (2697d)