2013-03-29 14 views
10

スプレーアプリケーションのルートのドキュメントを自動化することは可能ですか?ルートのREST APIドキュメントの自動化

おそらくスプレールートについて知っていることを説明するマークダウンを生成するSBTプラグインはありますか?

+2

https://groups.google.com/forum/#!topic/spray-user/0kxLzNRhnU4によると、あまり利用できるものはありません。そのスレッドで言及されているすべてのソリューションは宣言的です。 –

+0

スプレーレストのAPIを文書化する方法を見つけましたか? – dirceusemighini

答えて

3

同じことを調べているうちに私はspray-swaggerを見つけましたが、私はそれが何をしているのか、どの段階にあるのか正確には分かりません。

+0

これはうまくいきますが、すべてのメソッドであるようにルートを書き直すという面倒な要件があります(Sprayアプリケーションではルートを 'val'として定義するのが一般的です)。 Swaggerの 'ApiOperation'アノテーションはメソッドのみを対象としているからです。 – expert

関連する問題