在ring swagger中查询参数描述
我通过compojure-api使用ring-swagger。我有几个查询参数，我正在努力寻找一种方法来向单个查询参数添加描述。我可以添加整个endpoint的摘要，但这还不够。
是否可以使用ing-swagger/compojure-api向单个查询参数添加swagger描述？
共有1个答案
compojure。应用程序编程接口。甜蜜/描述。
例如：
(GET "/hello" []
:query-params [name :- (describe String "This is the swagger description for the parameter")]
(ok {:message (str "Hello, " name)}))
-
我正试图弄清楚如何在OpenAPI中记录我的两个查询参数。 null 键是一个关联数组，可以包含API中的资源名称集合列表。分配给每个筛选项的值是单个id或逗号分隔的id列表。 排序 For排序也遵循JSON：API建议，因此如下所示： null 例如，我不确定是否可以指定过滤器键是一个关联数组，或者它接受逗号分隔的ID列表。对于排序几乎同样的问题：如何表示逗号分隔的排序字段列表？
-
查询创建工具及查询编辑器都支持在查询文本使用参数。你可以设置查询参数来在每次运行查询时添加变量值。参数应作为一个识别符以 $ 开头，[ ] 括住，例如 [$任何名]。 运行查询及 输入参数 对话框提供你输入想要搜索的数据。
-
查询支持在查询文本内使用参数。你可以设置查询参数，于每次运行查询时添加变量值。参数是一个以 $ 开头以及用 [ ] 括住的标识符，例如：[$任何名]。 运行查询时，你可以在“输入参数”对话框输入你想要搜索的数据。如勾选“原始模式”选项，将不会在传递输入值到查询时添加引号。
-
查询支持在查询文本内使用参数。你可以设置查询参数，于每次运行查询时添加变量值。参数是一个以 $ 开头以及用 [ ] 括住的标识符，例如：[$任何名]。 运行查询时，你可以在“输入参数”对话框输入你想要搜索的数据。如勾选“原始模式”选项，将不会在传递输入值到查询时添加引号。
-
查询支持在查询文本内使用参数。你可以设置查询参数，于每次运行查询时添加变量值。参数是一个以 $ 开头以及用 [ ] 括住的标识符，例如：[$任何名]。 运行查询时，你可以在“输入参数”对话框输入你想要搜索的数据。如勾选“原始模式”选项，将不会在传递输入值到查询时添加引号。
-
这是继续这个问题。 我添加了一个模型来获取查询参数到pydantic模型 它按预期工作，但描述（在模型中添加）没有反映在 Swagger UI 中 但是，如果请求正文使用相同的模型，则描述将以大摇大摆的方式显示 为了在swagger ui中获得对QueryParams(model)的描述，我是否遗漏了什么？