註釋中的spring-restdocs字段說明

Question

是否可以使用註釋（在字段級別）爲字段提供說明？

我知道我可以使用description方法爲

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

，但我寧願把那說明連同場的定義，在我的響應對象。

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字段說明：

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