Início / coding / Perguntas / 77152912
Accepted
xpt
Asked: 2023-09-22 02:49:13 +0800 CST

O OpenAPI pode especificar o que o endpoint retorna diretamente nas próprias respostas dos caminhos?

  • 772

De acordo com https://swagger.io/docs/specification/describe-responses/ ,
uma especificação típica de respostas de endpoint é:

paths:
  /ping:
    get:
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
                example: pong

O pongé colocado na exampleseção.

Existe alguma maneira de definir essa resposta fixa na própria especificação OpenAPI?

syntax

1 respostas

  1. Best Answer

    Você pode limitar sua stringresposta a uma enumeração de valores

    paths:
  /ping:
    get:
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
                enum:
                  - pong
                example: pong
    • 1

relate perguntas