APIのドキュメント、書くのたいへんですよね。 作っても放置されて更新されず誰も読まなくなったなんてこともあると思います。 今回はswaggerを使って、ドキュメントの生成を楽にしてみました。 swaggerとは swaggerとはAPIドキュメント生成ツールです。 http://swagger.io/ コード内に特定の記述でコメントを含めておくと、コマンド実行でAPIドキュメントを生成してくれます。 今回の環境 多くので言語でライブラリが用意されていますが、 今回はphpのLaravelフレームワークでの使い方を紹介します。 php composer Laravel4 or 5 使い方 インストール まずcomposerで必要ライブラリをインストールします。 Laravelプロジェクトのルート・ディレクトリで実行。
![LaravelプロジェクトのAPIをswaggerを使ってドキュメント化 - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/768f3c78503ea543691225d9afaf955b74c4e1c1/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9TGFyYXZlbCVFMyU4MyU5NyVFMyU4MyVBRCVFMyU4MiVCOCVFMyU4MiVBNyVFMyU4MiVBRiVFMyU4MyU4OCVFMyU4MSVBRUFQSSVFMyU4MiU5MnN3YWdnZXIlRTMlODIlOTIlRTQlQkQlQkYlRTMlODElQTMlRTMlODElQTYlRTMlODMlODklRTMlODIlQUQlRTMlODMlQTUlRTMlODMlQTElRTMlODMlQjMlRTMlODMlODglRTUlOEMlOTYmdHh0LWFsaWduPWxlZnQlMkN0b3AmdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT01NiZzPWE1YjgyMWU0YzZhZmM2YjI3MjJjM2FhNDY3NjY3ZWMz%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDB3cmJzcyZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTM2JnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnM9YjI3MjU4OTc2YmNhZTA4OGNjNmM2ZDk1Nzk5ZTBlNGU%26blend-x%3D142%26blend-y%3D486%26blend-mode%3Dnormal%26s%3D35522667d605bdc125062421519cf2aa)