質問: rest api(ジャージー実装)のドキュメントを自動化する方法 rest jersey(およびjaxb)を使用して、非常に広範なjava apiを作成しました。また、wikiを使用してドキュメントを作成しましたが、完全に手動のプロセスであり、特に修正が必要な場合は、wikiの更新を忘れがちです。見回すと、他のほとんどのrest apiも手動でドキュメントを作成しています。しかし、これにはおそらく良い解決策があるのだろうかと思っています。各エンドポイントについて文書化する必要がある種類は次のとおりです。 サービス名 カテゴリー uri パラメータ パラメータの種類 応答タイプ 応答タイプスキーマ(xsd) サンプルのリクエストとレスポンス リクエストの種類(取得/挿入/投稿/削除) 説明 返される可能性のあるエラーコード そしてもちろん、グローバルないくつかの一般的なものがあります セキュリティ restの概要 エラー処理 等 これらの一般的なことは一度説明すれば問題なく、自動化する必要はありませんが、webサービスメソッド自体にとっては、自動化することが非常に望ましいと思われます。注釈を使用して、xmlを生成する小さなプログラムを作成し、次にhtmlで実際のドキュメントを生成するxsltを作成することを考えました。カスタムxdocletを使用するほうが理にかなっていますか?
回答: swagger は美しいオプションです。 githubのプロジェクトであり、mavenの統合と、柔軟性を維持するためのその他のオプションがあります。統合ガイド: https://github.com/swagger-api/swagger-core/wiki 詳細: http://swagger.io/