如何在Swagger中指定获取参数的示例?
我正在使用在线为我的API创建一个招摇过市的规范 我的API有一个GET请求端点,我使用以下YAML代码来描述输入参数:如何在Swagger中指定获取参数的示例?,swagger,swagger-2.0,swagger-editor,openapi,Swagger,Swagger 2.0,Swagger Editor,Openapi,我正在使用在线为我的API创建一个招摇过市的规范 我的API有一个GET请求端点,我使用以下YAML代码来描述输入参数: paths: /fooBar: get: tags: - foobar summary: '' description: '' operationId: foobar consumes: - application/x-www-form-urlencoded p
paths:
/fooBar:
get:
tags:
- foobar
summary: ''
description: ''
operationId: foobar
consumes:
- application/x-www-form-urlencoded
produces:
- application/json
parameters:
- name: address
in: query
description: Address to be foobared
required: true
type: string
example: 123, FakeStreet
- name: city
in: query
description: City of the Address
required: true
type: string
example: New York
如果我输入示例
标记,我会得到一个错误:
不完全是来自,
在Swagger中编写GET参数时如何设置示例?OpenAPI 2.0
OpenAPI/Swagger 2.0没有非主体参数的示例
关键字。您可以在参数说明中指定示例。一些工具,如Swagger UI v2、v3.12+和Dredd,也为此支持x-example
扩展属性:
参数:
-姓名:地址
in:查询
描述:地址为foobared。例如:`123,FakeStreet`#