首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >Swashbuckle:带有查询参数的POST API端点

Swashbuckle:带有查询参数的POST API端点
EN

Stack Overflow用户
提问于 2019-01-11 21:35:33
回答 1查看 379关注 0票数 0

我需要帮助覆盖swagger生成器来处理API端点,并将查询参数记录在swashbuckle中。

我已经找到了一个链接,它用激烈的方法解释了如何覆盖swagger生成器。

例如:我有两个相同的路由定义端点:

  • POST /api/customer (路由模板-> /api/customer)
  • POST /api/customer?f={f}&l={l} (路由模板-> /api/customer)

默认的swagger生成器的问题是它给出了与相同端点的冲突。我尝试了ResolveConflictingActions方法,但没有起到多大作用。

需要实际工作代码的帮助,这些代码覆盖了swashbuckle中的swagger生成器和带有查询参数(如这个图像 )的文档端点

EN

回答 1

Stack Overflow用户

发布于 2019-01-16 15:32:24

您从Swashbuckle获得的错误是正确的,您试图为同一路由创建多个操作,查询参数不会使路径唯一。这违反了Swagger规范。来自OpenAPI规范..。

对于每个路径,定义可用于访问该路径的操作(HTTP方法)。OpenAPI 3.0支持get、post、put、修补程序、删除、头、选项和跟踪。单个路径可以支持多个操作,例如,获取/users以获取用户列表,并发布/users以添加新用户。OpenAPI将唯一的操作定义为路径和HTTP方法的组合。这意味着不允许为同一路径使用两个GET或两个POST方法--即使它们有不同的参数(参数对唯一性没有影响)。

您应该创建一个路径,查询参数是可选的。最后,您将使用兼容的swagger定义获得相同的API。

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/54154360

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档