5

我在控制器中使用泛型。例如，从某些端点我返回Response<News>和Response<Tag>.

嗯，Swagger 会自动生成这部分 yaml

responses:
        200:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseNews'

和

responses:
        200:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseTags'

这是我在 Java 中的响应实体。

public class Response<T> {
    private List<T> data;
    private Boolean moreDataExists;
}

这就是 Swagger 生成组件的方式。

ResponseNews:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/News'
        moreDataExists:
          type: boolean

ResponseTags:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
        moreDataExists:
          type: boolean

好吧，它几乎是重复的代码。我想避免它，只在我的端点描述中使用Response，并明确地向我的用户展示我使用泛型。

像这样的东西：

responses:
        200:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
                  contains: 
                    $ref: '#/components/schemas/News'

我已经准备好在没有 Swagger 的情况下手动完成它。有没有办法做到这一点，也许使用继承或多态？

4

1 回答 1

1

您可以通过使用@ApiResponseswagger 注释来调整响应，您可以在其中传递所需的任何自定义对象的架构。

于 2020-05-01T11:32:50.673 回答