Swagger 多个示例未显示

Fre*_*nda 2 yaml swagger

当我将示例添加到我的 swagger 文档中并在 swagger 编辑器上进行测试时,它永远不会显示在任何地方。有人能给我一个例子,说明多个例子实际上在任何地方显示吗?

以下是如何添加多个示例的示例: 在此处输入图片说明

它来自:https : //swagger.io/docs/specification/adding-examples/

下面是一个 yaml 示例,它examples在在线 swagger 编辑器上不显示任何内容:

openapi: 3.0.0
info:
  title: Some API
  version: 1.0.0
paths:
  /logon:
    get:
      summary: Login user
      tags:
        - '/logon'
      parameters:
        - name: Client
          in: query
          required: true
          examples:
            zero:
              value: '0'
              summary: A sample limit value
            max:
              value: '50'
              summary: A sample limit value
          schema:
            type: string
      responses:
        '200':
          description: Success response
Run Code Online (Sandbox Code Playgroud)

Hel*_*len 7

多个examples显示在 Swagger UI 3.23.0+ 和 Swagger Editor 3.6.21+ 中:

Swagger UI 使用下拉列表显示多个示例


在旧版本中,您可以使用单个example作为解决方法:

      parameters:
        - name: Client
          in: query
          required: true
          example: '50'  # <-----
          schema:
            type: string
Run Code Online (Sandbox Code Playgroud)

  • 哦,好吧。让您想知道为什么当它没有显示时他们将它放在文档中。对 Swagger 真的很失望。我希望它们不是行业标准。我一直在努力让东西在没有良好文档的情况下工作......对不起。不过还是谢谢你的回答! (4认同)