当前位置: 首页 > 知识库问答 >
问题:

Swagger多个示例未显示

白和泽
2023-03-14

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

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

以下是一个yaml示例,它在在线招摇过市编辑器上不显示任何示例

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

共有1个答案

查飞星
2023-03-14

Swagger UI 3.23.0和Swagger Editor 3.6.21中显示了多个示例


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

      parameters:
        - name: Client
          in: query
          required: true
          example: '50'  # <-----
          schema:
            type: string
 类似资料:
  • 在我的REST API补丁操作中,我使用的是v3 我试图为我的补丁操作添加更多的示例作为swagger模式。 请求主体: 目前我有以下类的请求模型。 在PatchOperation.java中 @补丁 有没有办法,我可以为getOP、getPath和getValue方法添加多个示例?谢谢你。

  • 我用虚张声势的皮带扣。AspNetCore库生成Swagger文档。是否可以将多个错误消息添加到一个状态代码中?例如,我有一个字段,它有验证,所以我需要在我的文档中使用它: 在以前版本的库中,我可以将验证错误放入描述中,但该属性在最新版本中不可用。我们有没有描述参数的属性。

  • 我已经将swagger与django rest框架集成在一起,但是swagger文档没有创建一个输入框来发布post请求的数据。 我的解析器设置, }

  • 我找不到为什么Swagger没有显示带有文本区域“body”的POSTendpoint,以便我可以将JSON粘贴到其中。 我本以为会看到这样的页面,在PetStore中大摇大摆地发布 但我的表格只是在我点击“试用”后发布的 你能帮我一下吗? 专家 配置 } 应用程序 } 促销SwaggerBundle } 终点,终点

  • 我正在用Swagger创建一个API文档。我直接尝试了openapi 3.0。不知何故,我无法得到我的请求机构工作的描述。 但这些描述不会出现: 我想得到像《大摇大摆2》那样的东西。下面是如何将相同的代码转换为Swagger 2

  • 因此,我对正在构建的文档中的Springfox Swagger有这个问题。我使用的是3.0.0版本。我有一个类似这样的类 但是,当我在我的Spring启动应用程序的swagger用户界面中查看模式模型页面时,参数b的值没有显示出来。我不能将描述放在MyObj中,因为这是一个通用类,用于多个实例,并且描述会根据使用而变化。 编辑:任何灵长类类型(如string或int)的描述都可以很好地工作,只要使