Как использовать ответные ссылки OpenAPI 3.0 в Swagger UI? - PullRequest
3 голосов
/ 25 апреля 2019

Я пишу спецификацию Open API 3.0 и пытаюсь получить ссылки ответа для рендеринга в Swagger UI v 3.18.3.

Пример:

openapi: 3.0.0
info:
  title: Test
  version: '1.0'
tags: 
  - name: Artifacts
paths:
  /artifacts:
    post:
      tags: 
        - Artifacts
      operationId: createArtifact
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        201:
          description: create
          headers:
            Location:
              schema:
                type: string
                format: uri
                example: /artifacts/100
          content:
            application/json:
              schema:
                type: object
                properties:
                  artifactId:
                    type: integer
                    format: int64
          links:
            Read Artifact:
              operationId: getArtifact
              parameters:
                artifact-id: '$response.body#/artifactId'
  /artifacts/{artifact-id}:
    parameters:
      - name: artifact-id
        in: path
        required: true
        schema:
          type: integer
          format: int64
    get:
      tags: 
        - Artifacts
      operationId: getArtifact
      responses:
        200:
          description: read
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary

отображает такую ​​ссылку:

Response Link Example

Ожидается ли это?Я спрашиваю, потому что operationId отображается в пользовательском интерфейсе, а parameters отображается в виде ссылки JSON, что создает впечатление, что что-то не отображается должным образом.Я ожидал, что гиперссылка или что-то еще приведет меня к соответствующему разделу на веб-странице Swagger, который соответствует API, на который ссылается ссылка.

1 Ответ

2 голосов
/ 25 апреля 2019

Да, именно так Swagger UI в настоящее время отображает OAS3 links. Рендеринг links является одной из вещей на их отставание поддержки OAS3 :

Журнал поддержки OAS 3.0
Это входной билет для функций спецификации OAS3, которые еще не поддерживаются Swagger-UI.
...
[] Ссылки не могут быть использованы для выполнения другой операции
[] Серверы уровня связи недоступны для выполнения запросов

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...