Swagger ссылается на ответ на объект Spring, разбивая страницы на Swagger

Question

В моем проекте я генерирую все конечные точки контроллера, используя шаблон Swagger, я пытаюсь реализовать конечную точку, которая возвращает объект Spring * Page вместо списка.

Вот что у меня есть:

responses:
        200:
          schema:
            type: array
            items:
              $ref: '#/definitions/Metadata'

И он генерирует:

public ResponseEntity<List<Metadata>> getMetadataList()

Но я хочу, чтобы Swagger генерировал ответ с Page Spring вместо списка:

public ResponseEntity<Page<Metadata>> getMetadataList()

Как я могу сослаться вSwagger шаблон для объекта Spring's Page?Должен ли я определить свой собственный объект Page, а затем сопоставить страницу Spring с моим объектом?

Answer 1

Прикрепленные сгенерированные swagger api docs с объектом Page.

чванство

responses:
        '200':
          description: OK
          schema:
           $ref: '#/definitions/Page%C2%ABMetadata%C2%BB'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
definitions:
  Metadata:
    type: object
    properties:
      data:
        type: string
    title: Metadata
  Pageable:
    type: object
    properties:
      offset:
        type: integer
        format: int64
      pageNumber:
        type: integer
        format: int32
      pageSize:
        type: integer
        format: int32
      paged:
        type: boolean
      sort:
        $ref: '#/definitions/Sort'
      unpaged:
        type: boolean
    title: Pageable
  Page«Metadata»:
    type: object
    properties:
      content:
        type: array
        items:
          $ref: '#/definitions/Metadata'
      empty:
        type: boolean
      first:
        type: boolean
      last:
        type: boolean
      number:
        type: integer
        format: int32
      numberOfElements:
        type: integer
        format: int32
      pageable:
        $ref: '#/definitions/Pageable'
      size:
        type: integer
        format: int32
      sort:
        $ref: '#/definitions/Sort'
      totalElements:
        type: integer
        format: int64
      totalPages:
        type: integer
        format: int32
    title: Page«Metadata»
  Sort:
    type: object
    properties:
      empty:
        type: boolean
      sorted:
        type: boolean
      unsorted:
        type: boolean
    title: Sort