为第三方自动生成 swagger 响应 class

Question

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

Answer 1

您有多种选择。

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

接下来，大多数框架允许您在呈现 Swagger 文档之前对其进行拦截。您或许可以手动修改文档，并添加您需要的描述和元数据。

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