主页 / coding / 问题 / 77152912
Accepted
xpt
Asked: 2023-09-22 02:49:13 +0800 CST

OpenAPI 能否指定端点在路径响应本身中返回的内容？

  • 772

根据https://swagger.io/docs/specification/describing-responses/，
典型的端点响应规范是：

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

被pong放入该example部分。

有什么方法可以在 OpenAPI 规范本身中定义这种固定响应吗？

syntax

1 个回答

  1. Best Answer

    您可以将您的string响应限制为枚举值

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

相关问题