spring-mvc rest APIドキュメントのjavadocのようなツールですか？

Question

javadocのようなREST APIドキュメントツールを探していました。私はすでにjavadocでレストコントローラを文書化していました。フロントエンド開発者のためのAPIドキュメントを作成するだけでいいと思います。

まだツールがないと思います。だから誰かがこのタスクを達成するためのアイデアを持っていますか？私は古典的なjavadocツールを使用し、スプリング/レスト固有のロジックを追加することを考えました。しかし、私はまだ特別なマークアップが必要なのか、落とし穴になるのか分かりません。最後に、私はになることができるいくつかのツールをmavenのサイトライフサイクルに統合したいと思いますが、それは達成するのが難しいはずはありません。

継承を扱うのが難しいかもしれません：私はそれをRESTリソース全体に多く使用しますが、読者にとっては、継承は気にする必要はありません。したがって、サブコントローラは、スーパーコントローラのメソッドを何らかの形で統合しなければならないだけでなく、実際のコントローラのコンテキストで意味のあるドキュメントを作成できる必要があります。私は、春が私にスーパーコントローラからのメソッドを上書きすることができるかどうかは分からないが、その注釈を評価している。

関連プロジェクト、既に存在するツール、またはjavadocツールの経験を参考にしてください。

Answer 1

することは、あなたがこのようにそれに近づくことができます：それはname属性を読み取ることができることを、様々な@Path注釈

テストをスキャンAnnotationReader実装を作成し

2. このスキャン機能をラップするMaven mojoを作成する
3. 正規表現のパラメータ（例：{customerId}）を意味のあるものにマップする機能を追加するおそらく関連するJavadocを読むことによってドキュメント化することができます。

注釈リーダーは既存の注釈を変更する必要がないので、エンドポイント正規表現のリストを作成するのは簡単です。 Javadocと組み合わせると、便利なツールを作成できるはずです。私はそれが役に立つと確信しています。

Answer 2

私はEnunciateを知っていますが、これはJersey/CXFでもうまくいきますが、SpringMVCの場合はわかりません。あなたはこの自分をやってみたかった場合

Answer 3

RESTdocletを見てください。 http://ig-group.github.com/RESTdoclet/