注释中的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