Play 2.xのAPIドキュメントを生成するためのプラグインはありますか？

Question

Play 2.xの上に比較的大きなREST APIビルドがあり、内部ユーザー用にドキュメント化することが任されています。別のwikiにこれを維持することは非常に難しいと私たちは考えているので、Play用のツールを生成するドキュメントがあるかどうかは疑問です。

Answer 1

SWAGGERは2プレイサポート提供：

https://github.com/swagger-api/swagger-play

プレイ2自体は、あなたが呼ぶときに何が起こるか、チェックアウト、便利なフォーマットでそのルータにドキュメントを提供します。

Play.current.routes.foreach(r => println(r.documentation)) 

Answer 2

私が推測するにプレイ2.4、あなたはルータを注入するだろう：

class Health @Inject() (router: Router) extends Controller { 
    def doc = Action { implicit request => 
     val myroutes = router.documentation.map { 
     x => Json.obj("http_method" -> x._1, "path" -> x._2, "scala" -> x._3) 
     } 
     Ok(Json.obj("k" -> myroutes)) 
    } 
    } 

しかし、これは本当に良いAPIドキュメントではありません。あなたは、あなたが取得しなければならないもの、何をPOSTする必要があります取得しないでください。競技外REST-APIのドキュメントを取得するためのより良い方法がありイスト場合

はまだ私が今RAMLを使用しています...、

Answer 3

を不思議。 http://raml.org/

自動apiドキュメントの生成はありません。 apiドキュメントを手動で作成して変更する必要がありますが、これはまったく悪くありません。 もちろん、あなたがあなたのAPIを変更した場合は、apiの文書も変更する必要があります。それが失敗のポイントです。

しかし、これは次のとおりです。注釈とAPIのコメントでコードを汚染しないでください。それは私にとって最も重要な点です。 "api doc language"は、実際には簡単に習得できます。