NelmioApiDoc v3 / Swagger - 多个 API 文档

Posted 2023-02-16

【中文标题】NelmioApiDoc v3 / Swagger - 多个 API 文档

【英文标题】：NelmioApiDoc v3 / Swagger - multiple API docs

【发布时间】：2018-06-18 16:26:56

【问题描述】：

NelmioApiDoc v2 允许使用多个 views 参数，因此我可以隐藏一些端点并将它们呈现在不同的 URL 上

https://symfony.com/doc/current/bundles/NelmioApiDocBundle/multiple-api-doc.html

是否可以在使用 Swagger 的 NelmioApiDoc v3 中做到这一点？

我正在使用 Symfony 3.3

【参考方案1】：

现在在 NelmioApiDoc v3 中，您正在寻找的内容似乎被称为“区域”。 借助此功能，您可以定义每个区域都会生成不同的文档：

您只需在 config.yml 中定义这些区域：

nelmio_api_doc:
    areas:
        default:
            path_patterns: [ ^/api ]
        custom:
            path_patterns: [ ^/custom ]
        another_custom:
            path_patterns: [ ^/anothercustom ]

然后你需要更新你的 routing.yml 文件：

app.swagger_ui:
    path: /api/doc/area
    methods: GET
    defaults:  _controller: nelmio_api_doc.controller.swagger_ui, area: default 

您可以在this doc 上阅读。

【讨论】：

虽然此链接可能会回答问题，但最好在此处包含答案的基本部分并提供链接以供参考。如果链接页面发生更改，仅链接答案可能会失效。 - From Review

@Prashant Tukadiya：明白！我编辑了我的答案；）

我想我现在可以接受你的回答了。 V3.1 现已发布