Nelmio ApiDoc 3.0 - 从 SwaggerUI 中排除部分

Posted

技术标签:

【中文标题】Nelmio ApiDoc 3.0 - 从 SwaggerUI 中排除部分【英文标题】:Nelmio ApiDoc 3.0 - exclude section from SwaggerUI 【发布时间】:2018-03-22 19:43:35 【问题描述】:

我想从 SwaggerUI 中排除“默认”部分 - 在那里我保留了我不想公开的路线。我知道在 Nelmio Apdoc 的 2.x 版本中,config.yml 中有一个名为 exclude_sections 的参数 - 我如何使用 3.0 beta 版本来做到这一点?

【问题讨论】:

【参考方案1】:

您可以使用config.yml 中的areas 部分,将默认区域设置为您想要的任何路线:

nelmio_api_doc:
    documentation:
        [...]
    areas:
        default:
            path_patterns: [ ^/user, ^/customer ]

此配置将在 api/doc 下仅设置您放入数组中的路由。

【讨论】:

以上是关于Nelmio ApiDoc 3.0 - 从 SwaggerUI 中排除部分的主要内容,如果未能解决你的问题,请参考以下文章

如何在 Nelmio ApiDocBundle 中指定参数的格式

为啥自定义路由在 Nelmio API Doc 中出现两次?

如何使用自定义 JMS 序列化程序处理程序设置 Nelmio Doc

Symfony、nelmio/api-doc-bundle 和 @SWG\SecurityScheme

在 Swagger / Zircote / Nelmio-api-doc 中使用外部定义

PHP/Symfony API 的 CORS 问题 Nelmio