0
POST操作のリクエスト本体としてJSONを受け入れるSpring Boot RESTful APIがあります。 JSONは、Jackson ObjectMapperを使用して特定のオブジェクトに変換されます。より多くのチームがAPIを使用しているので、最新のドキュメントが必要です。私はSwaggerとSpring REST DocsをAPIの文書化方法として見てきました。しかし、私は自分の状況に役立つ例は見ていません。JavaxアノテーションとHibernate検証を使用してPOJOのコードを文書化する
私は多くのPOJOを持っています。それらはすべて共通のPOJOから継承され、いくつかは継承の連鎖をたくさん持っています。存在する多くの異なるPOJOが存在し、それぞれ異なるイベントを表します。 POJOには、JSONを記述する@NotNullやその他のObjectMapperアノテーションのようなアノテーションがあります。これらのPOJOやモデルをコードで文書化して、コードに最新のドキュメントが常にあるようにしたいと考えています。私たちのPOST APIは多くの異なるモデルを受け入れていますし、Spring REST Docsのオンライン例もまだ見ていないので、Swaggerは私たちのケースではあまりに単純すぎるようです。
基本的に、私の質問は：POJOのコードをアノテーションで文書化できますか？ありがとう！
注釈は使用しませんが、Spring REST Docsでは[要求と応答ペイロードの文書化]（http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting- your-api-request-response-payloads）と[その制約]（http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting-your-api-constraints） –
こんにちはAndy私はSpring REST Docsのオンライン版の例はまだ見ていないが、それは私にとって最も適していると思う。 Spring REST Docsの実例をオンラインで実際に知っていますか？ – PhillipAMann
RESTドキュメント自体にはいくつかのサンプルがあります（https://github.com/spring-projects/spring-restdocs/tree/master/samples）。いくつかの人々がそれについてもブログしてきました。 http://info.michael-simons.eu/2015/11/05/documenting-your-api-with-spring-rest-docs/、http://yetanotherdevblog.com/introduction_to_spring_restdocs、https：// mediumを参照してください。 .com/@ flbenz/beautiful-api-documentation-with-무시できるオーバーヘッド - 2ba523205f61＃.fvvhjp6v0など。 –