在Swagger(OpenAPI)中添加JSON请求和响应示例的方法如下:
example
来指定请求示例的JSON数据。例如:parameters:
- name: body
in: body
required: true
schema:
type: object
properties:
name:
type: string
example:
name: "John Doe"
在上面的示例中,我们通过example
字段给出了一个请求示例,其中name
字段的值为"John Doe"。
examples
,用于指定该响应码对应的响应示例的JSON数据。例如:responses:
'200':
description: OK
examples:
application/json:
id: 1
name: "John Doe"
在上面的示例中,我们通过examples
字段给出了一个成功响应码200
对应的响应示例,其中包含了id
和name
字段的值。
通过上述步骤,我们可以在Swagger(OpenAPI)中添加JSON请求和响应示例,方便开发者理解和使用API接口。关于Swagger(OpenAPI)的更多信息和腾讯云相关产品和服务,你可以参考腾讯云的文档:腾讯云API网关-文档中心。
领取专属 10元无门槛券
手把手带您无忧上云