在swagger/openAPI 3.0文档中,可以通过使用"Examples"关键字来将"Example Value"和"Schema"并排显示。在API定义的参数或响应体中,可以使用"Examples"关键字来提供示例值,并将其与"Schema"并排显示。这样可以更清晰地展示参数或响应体的结构和示例值。
以下是一个示例:
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"将会并排显示,使得用户可以更直观地了解参数或响应体的结构和示例值。
腾讯云相关产品和产品介绍链接地址:
领取专属 10元无门槛券
手把手带您无忧上云