【问题标题】:Doc failing to generate multiple actions single operation文档无法生成多个操作单个操作
【发布时间】:2015-03-03 18:10:05
【问题描述】:

我想知道是否有人在使用 Swagger / Swashbuckle 5.0.1 记录一个可以对它执行多个操作的单个操作时遇到过解决方法。例如,采取以下方式:

api/products
api/products?productType='cheese'

尝试生成文档时,我收到一条错误消息,提示不支持此操作。但是,Swagger 文档建议通过合并来解决。

我不明白他们的意思以及如何去做。谁能提供任何信息?

按照他们的文档中的建议,我能够找到的唯一解决方法是执行以下操作(使用第一个条目解决):

c.ResolveConflictingActions(x => x.First());

这并不理想,因为从 API 的角度来看,我希望所有变体都呈现/可见。

【问题讨论】:

  • 您在哪里可以弄清楚如何使用 swagger 获得多个操作?
  • 否,显然在 git 页面上,这是预期的行为。我已经放弃使用它,因为它有很多问题,你不得不调整生成的 YAML。
  • @Null 这可能会很有帮助github.com/domaindrivendev/Swashbuckle/issues/…,其他人也在经历这个。
  • 我在 Stackoverflow 上发现了一个类似的帖子,建议将重载方法命名为不同的名称,然后简单地使用路由属性来定义路由。例如,如果我已经有了“Get()”,那么只需将第二个方法命名为“GetProduct()”。然后,我将创建一个路由属性并将路由设置为 'api/' 并定义了 'HttpGet' 动词。这解决了我的问题。

标签: c# asp.net-web-api swagger


【解决方案1】:

如 Swashbuckle SwaggerConfig.cs 文件中所述,此设置:

与 WebApi 相比,Swagger 2.0 不包含查询字符串 映射 URL 时的组件

这不是 Web API 问题,Swagger 2.0 规范实际上不支持有查询参数。

【讨论】:

猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2014-06-20
  • 1970-01-01
  • 2012-07-13
  • 1970-01-01
  • 2019-05-27
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多