swagger-playでAPIドキュメントを自動生成する - Qiita

概要 フロントエンジニアや外部に公開するAPIを用意する時、APIドキュメントを書くのは地味に面倒ですよね。 最近ではswaggerを筆頭に、ドキュメント生成ツール（Mockサーバーも内蔵しているものもある）が充実してきているので、それを使っていい感じにドキュメントを作りたいと思います。 play2もswagger pluginがあるので、それを使ってドキュメント生成をコード側でやってしまいましょう。 （筆者はswaggerを使ったことがなかったので、swagger自体の使い方も含んだ記事になります。） 環境 （執筆時点では、swagger-playがplay2.5対応しきれていなかったので、forkされたものを使用しています） Play 2.5 swagger-play (CreditCardsComがforkしたもの) ソースコードはこちら ゴール （アノテーションベースで）ある程度わ