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

如何在OpenAPI 2.0中定义对象数组?

在OpenAPI 2.0中,可以使用type: array来定义对象数组。下面是一个示例:

代码语言:txt
复制
definitions:
  User:
    type: object
    properties:
      id:
        type: integer
      name:
        type: string

paths:
  /users:
    get:
      summary: 获取用户列表
      responses:
        200:
          description: 成功返回用户列表
          schema:
            type: array
            items:
              $ref: '#/definitions/User'

在上述示例中,我们定义了一个名为User的对象,它包含idname两个属性。然后,在/users路径下的GET请求中,我们使用schema关键字来定义返回的响应数据类型。通过type: array指定返回的是一个数组,然后使用items关键字来指定数组中每个元素的类型,这里使用了$ref关键字来引用之前定义的User对象。

这样,当调用/users接口时,将返回一个包含多个用户对象的数组。

推荐的腾讯云相关产品:腾讯云API网关。腾讯云API网关是一种全托管的API管理服务,可帮助开发者轻松构建、发布、维护、监控和安全地扩展API。通过API网关,您可以方便地定义和管理API的结构和规则,包括对象数组的定义。您可以在腾讯云官网了解更多关于腾讯云API网关的信息:腾讯云API网关

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

领券