Swagger中API查询参数的可能值列表
在记录API时，有没有办法提供可能值的列表？类似于这样：
{
"name": "propertyType",
"in": "query",
"description": "Type of home",
"required": false,
"type": "list",
"listValues": ["singleFamilyHome", "condo", "farm", …]
}
共有1个答案
在swagger 2.0中，您可以使用枚举：
{
"name": "propertyType",
"in": "query",
"description": "Type of home",
"required": false,
"type": "list",
"enum": ["singleFamilyHome", "condo", "farm"]
}
你可以在这里找到更多信息：如何在swagger.io?中定义枚举
-
我正在尝试在我的 REST 服务中实现分页。 取1: 这是SpringFox / Swagger中的一个已知错误，Swagger页面显示了错误的参数名。另外，我只想要佩奇 第二次: 这给了我正确的参数，但是它不允许我设置参数描述或示例值。 取3： 这还有另一个错误，在这个错误中，例如="0"不起作用，但是除了一个有效的值之外，所有其他值都有效，哈哈。如果我将数据类型更改为字符串，那么它将显示0示例
-
在我的Zend应用程序中，我正在为移动应用程序编写一个小API。为了方便移动开发者，我使用了Swagger。到目前为止，除了一个GET请求外，一切正常。 当我呼叫/user/messages/{sessionToken}时？numMessages=｛numMessages｝ 有人知道我的错误吗？ 欢迎任何帮助。 诚挚的问候 罗特曼 更新：按照建议，我将两个参数类型都更改为“查询”并更改了路径： 但
-
我正在用Swagger 2.0记录一个Rails应用程序，并使用Swagger-UI作为人类可读的文档/沙盒解决方案。 我有一个资源，客户端可以在其中存储任意元数据以供以后查询。根据 Rails 约定，查询将按如下方式提交： Rails将其转换为以下参数： 它可以很容易地用于为数据库生成适当的 子句。 Swagger里有支持这种东西的吗？我想最终让Swagger-UI提供一些方法来修改生成的请求，
-
我在django中有一个api（Web服务），如下所示：http://127.0.0.1:9000/api/back_office/appointments/days/?branch=1，在swagger中，我想输入名为分支的查询参数，但不起作用（我所有的api都有同样的问题！！）。 以前，我使用旧版本的swagger，对于输入查询参数使用like - param_name语法，但是现在在djan
-
我通过compojure-api使用ring-swagger。我有几个查询参数，我正在努力寻找一种方法来向单个查询参数添加描述。我可以添加整个endpoint的摘要，但这还不够。 是否可以使用ing-swagger/compojure-api向单个查询参数添加swagger描述？
-
我不明白 FastAPI 中的可选查询参数。它与默认值为 的默认查询参数有何不同？ 在下面的示例中，arg1和arg2有什么区别？在该示例中，arg2是一个可选的查询参数，如上面的链接所述。