【问题标题】:auto generate swagger response for third-party class自动为第三方类生成招摇响应
【发布时间】:2016-10-19 02:23:53
【问题描述】:

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

【问题讨论】:

    标签: java swagger springfox


    【解决方案1】:

    您有多种选择。

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

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

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2021-08-22
      • 2017-01-27
      • 2022-01-23
      • 2017-12-19
      • 2019-04-05
      • 1970-01-01
      • 1970-01-01
      • 2019-08-29
      相关资源
      最近更新 更多