自动生成第三方类的招摇响应

时间:2016-10-19 02:23:53

标签: java swagger springfox

我正在使用springfox从我的spring-mvc restful应用程序中自动生成swagger-api-document。 为了使api清楚,我正在使用@ApiModelProperty为响应字段添加描述。最近有一个api响应第三方模型,我无法将@ApiModelProperty添加到它的来源。 那么如何为不受你控制的第三方模型添加@ApiModelProperty呢?

1 个答案:

答案 0 :(得分:0)

您有几种选择。

首先,响应模型不需要是您返回的具体类。因此它可能是UserDTO,但您可以轻松地将其声明为User。这使您有机会创建一个接口,甚至扩展您的具体类并添加@ApiModelProperty注释。

接下来,大多数框架允许您在呈现之前拦截Swagger文档。您可以手动改变文档,并添加所需的描述和元数据。

我建议采用第一种方法,因为它更容易实现,并为您提供所需的所有控制。