NelmioApiDoc v3 / Swagger - несколько документов API

NelmioApiDoc v2 разрешено использовать несколько views параметр, чтобы я мог скрыть некоторые конечные точки и представить их по другому URL

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

Возможно ли сделать это в NelmioApiDoc v3, который использует Swagger?

Я использую 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 }

Вы можете прочитать об этом в этом документе.

Другие вопросы по тегам