RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-09 02:59:27 +03:00
Code Issues Projects Releases Wiki Activity

Add extra name_patterns example to areas docs

Browse Source 
Add an extra `name_patterns` example to areas docs
This commit is contained in:
Alexandru Năstase 2021-05-07 16:56:52 +02:00 committed by GitHub
parent ef0ca8259d
commit 791b0ce15d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Resources/doc/areas.rst
View File

@ -29,6 +29,9 @@ You can define areas which will each generates a different documentation:
path_patterns: [ ^/internal ]
commercial:
path_patterns: [ ^/commercial ]
store:
# Includes routes with names containing 'store'
name_patterns: [ store ]
Your main documentation is under the ``default`` area. It's the one shown when accessing ``/api/doc``.
@ -48,4 +51,4 @@ Then update your routing to be able to access your different documentations:
# methods: GET
# defaults: { _controller: nelmio_api_doc.controller.swagger }
That's all! You can now access ``/api/doc/internal`` and ``/api/doc/commercial``.
That's all! You can now access ``/api/doc/internal``, ``/api/doc/commercial`` and ``/api/doc/store``.