Swagger

from https://qiita.com/disc99/items/37228f5d687ad2969aa2

ボトムアップ形式

  1. 既に存在するREST APIのソースコードからSwagger Coreのアノテーションなどを使用しSwagger Specification定義
  2. 生成されたSwagger SpecificationをもとにSwagger UIによって、REST APIをドキュメント化
Untitled.png





ボトムアップ形式

実際の開発ではトップダウンで生成したソースコードがそのまま扱えない場合も多いと思います。
また、既に開発が始まっているシステムなどはボトムアップ形式でのSwaggerを扱う方が有効な場合も多いと思います。



from http://gong023.hatenablog.com/entry/2014/05/15/152021

アノテーションからドキュメントを作れるswaggerの使い方

swagger を実行し json ファイルを得る

ひと通りアノテーションを書いたので、これらのアノテーションから json ファイルを作る。 この手順は swagger-php をインストールしてコマンドを叩けばOK。これを swagger-ui が食う。





留言

熱門文章