#contents

*趣旨 [#m08614bb]
SWAGGERのメモです。

*SWAGGER [#fbae6901]
RESTful APIs

モデルファーストなAPI開発。

RESTful な APIの仕様書とインタフェースを連動して記述できる

仕様書を書いて、その場でテストするツールも連動していて便利

また、swageer-edit使うと、各言語用に設定ファイルとかも吐き出してくれる

**標準を目指している。 [#vbfc02b5]

Open API InitiativeというREST APIの標準を決めようとしている団体があり、それはswaggerベースで書かれている。


**本家URL [#tbef5e2e]
http://swagger.io/

**インストール前提 [#u804ad29]
nodeがインストールしてある前提

*swaggerの設定ファイルの書き方 [#kfd9c0ac]
**設定ファイル [#g3755ce0]
swagger.jsonまたはswagger.yaml



*ツール [#k24884e3]
**swaggerの定義を読み込む [#a0afb8ad]
http://swagger.io/tools/

Swagger Core

**コマンドライン [#k4fae23f]
http://swagger.io/tools/

Swagger Codegen

**ブラウザでドキュメントを生成 [#xb92dd04]

Swagger UI

APIの仕様が一覧で見れる公式のデモがある。

http://petstore.swagger.io/

**ブラウザからjsonなどのの構文チェック [#y5cffde5]

Swagger Editor

公式サイトにデモがある
http://editor.swagger.io/#/



***swaggerの設定ファイル(swagger spec)の書き方 [#kfd9c0ac]

Swagger Editorを使って書いていく感じ

*参考URL [#lf4b2bb5]

swaggerの基礎。swaggerの設定ファイルの書き方とか

ツールを触ってみて概要をわかるようになるのが目的な感じの内容

http://qiita.com/magaya0403/items/0419d84d8df7784ac465


トップ   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS