【问题标题】:Is there a way to add a context for my methods (or exclude methods) in Swagger?有没有办法在 Swagger 中为我的方法(或排除方法)添加上下文?
【发布时间】:2020-08-07 04:39:04
【问题描述】:

我有 REST API,有些方法是公共的,有些方法是私有的。我想生成两个 API 文档,一个供所有人使用,另一个供私人使用。我使用https://github.com/nelmio/NelmioApiDocBundle,它使用https://github.com/zircote/swagger-php,它使用Swagger 2。

结果的一个很好的例子是 JMS 的上下文,我们可以在其中向我们的属性添加不同的组,并在需要将它们私有化时隐藏它们。

我知道在 Nelmio API 文档中,我们可以像在 JMS 中一样添加组,但我们不能以此来隐藏方法。

在这些抽象的任何级别上是否有任何方法可以做到这一点?

【问题讨论】:

    标签: php symfony swagger swagger-2.0 nelmioapidocbundle


    【解决方案1】:

    似乎https://github.com/nelmio/NelmioApiDocBundle 可以通过使用此处描述的区域配置自行解决我的问题https://symfony.com/doc/current/bundles/NelmioApiDocBundle/areas.html

    我以前使用过这些区域,但我在 yaml 中进行了部分配置,部分类似于 annocations,并且还在我的 nelmioApiDoc 配置中使用了 basePath,因此所有这些部分协同工作与我预期的有点不同。

    【讨论】:

      猜你喜欢
      • 2020-03-23
      • 2011-01-25
      • 2012-06-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2018-04-21
      • 2021-10-13
      • 1970-01-01
      相关资源
      最近更新 更多