首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

在swagger/openAPI 3.0文档中,有没有办法将"Example Value“和"Schema”并排显示?

在swagger/openAPI 3.0文档中,可以通过使用"Examples"关键字来将"Example Value"和"Schema"并排显示。在API定义的参数或响应体中,可以使用"Examples"关键字来提供示例值,并将其与"Schema"并排显示。这样可以更清晰地展示参数或响应体的结构和示例值。

以下是一个示例:

代码语言:txt
复制
openapi: 3.0.0
info:
  title: Swagger Example
  version: 1.0.0
paths:
  /users:
    post:
      summary: Create a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: User's name
              examples:
                example1:
                  value:
                    name: John Doe
                  summary: Example 1
                example2:
                  value:
                    name: Jane Smith
                  summary: Example 2
      responses:
        '200':
          description: OK

在上述示例中,使用了"examples"关键字来提供两个示例值,分别是"example1"和"example2"。每个示例值都包含一个"value"字段,其中包含了参数的实际示例值。同时,还可以使用"summary"字段来提供示例的简要描述。

这样,在生成的swagger/openAPI文档中,"Example Value"和"Schema"将会并排显示,使得用户可以更直观地了解参数或响应体的结构和示例值。

腾讯云相关产品和产品介绍链接地址:

  • 腾讯云API网关:https://cloud.tencent.com/product/apigateway
  • 腾讯云Serverless Framework:https://cloud.tencent.com/product/sls
  • 腾讯云云函数(SCF):https://cloud.tencent.com/product/scf
页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

  • 构建下一代 HTTP API - OpenAPI spec 和解析器

    在 抽象的能力 一文结尾的地方,我简单谈到了做 feed 的一些心得。当时我接手这个工作的时候,之前的工程师已经留下了好几万行 php 代码,这些代码处理几十个来自不同厂商的 feed,把里面的内容提取出来存在数据库中。因为 feed 的格式不尽相同,有 XML,有 JSON,同样表述一个数据,大家的字段名有时也不太一样,比如同样是 video url,有的叫 url,有的叫 media_url,它们在 XML/JSON 里所处的层级也不尽然相同。所以之前的代码为每个 feed 写了一个类。有新需求(比如新的 feed)时,找一个最类似的代码,copy & paste,然后在好几百行粘贴出来的代码中根据差异一点点修改,最终形成新的 feed 的处理代码。

    02
    领券