注釈からのSpring-restdocsフィールドの説明

Question

注釈（フィールドレベル）を使用してフィールドの説明を付けることはできますか？

私はその

.andDo(document("index", responseFields( 
      fieldWithPath("contact").description("The user's contact details"), 

ためdescription方法を使用することができます知っているが、私は私のレスポンスオブジェクトに、フィールド定義と一緒にその説明を置くことを好むだろう。

class IndexResponse { 
//The user's contact details 
String contract; 
} 

私は、制約の記述（http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#_using_constraint_descriptions_in_generated_snippets）を生成している可能性があることを知っているが、それは唯一の検証注釈の説明を生成しました。

Swaggerからhttps://github.com/swagger-api/swagger-core/wiki/Annotations#apimodelpropertyのようなものをお探しします。

Answer 1

これはありません。私はREST Docsプロジェクトの主導者です。注釈はドキュメントを書く良い方法ではありません。その意見に同意せず、アノテーションを使用したい場合は、制約の説明から行われたものと同様のアドオンを作成できます。それをイントロスペクションするクラスに渡して、FieldDescriptorのインスタンスを自動的に生成し、リクエストとレスポンスのフィールドスニペットに渡すことができます。

Answer 2

我々はフィールドの説明については、Javadocを使用可能に春RESTドキュメントの拡張建て：

class IndexResponse { 
    /** 
    * The user's contact details 
    */ 
    String contract; 
} 

しかしジャクソンとMockMvcテストが使用されている場合は、現在、この唯一の作品を。

プロジェクト：https://github.com/ScaCap/spring-auto-restdocs

紹介記事：https://dzone.com/articles/introducing-spring-auto-rest-docs