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

swagger の概要と、基本的な使い方をサンプルを交えて書く。 なお、終始 PHP なので気をつけて下さい。 swagger の概要 開発ドキュメントをどうやって書くかという話題は常々ある。そして一番素直なアプローチを取ると、大抵 wiki みたいなアプリケーションを用意して、そこにドキュメント書こうぜという話になる。しかし、この管理は割とすぐ破綻してしまう。 理由はいろいろあるが、最新のコードに追従できなくなるとか、統一されたフォーマットを保証できず書き手によっては何を書いているのか全くわからないとかそういうケースが多い。 前者について、 swagger はアノテーションでドキュメントを書けるので違いは起きづらくなる。（ それでも不足だが自分でライブラリ作って補った ） また後者に関していえば、swagger は API の仕様を記述するためのフォーマットを提供してくれる。 つまり、s

[Dai_Kamijo]

“アノテーションからドキュメントを作れるswaggerの使い方 - gong023の日記” — Masao Maeda (@brtriver) November 9, 2015 from Twitter https://twitter.com/Dai_Kamijo November 09, 2015 at 10:40AM via IFTTT

[t-tsuruoka]

細かいパラメータの意味を知りたいときは、https://github.com/swagger-api/swagger-spec/blob/master/versions/1.2.md を参照