mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-09 02:59:27 +03:00
update config reference
This commit is contained in:
parent
94ec568237
commit
0151624773
@ -127,7 +127,7 @@ The following properties are available:
|
|||||||
|
|
||||||
* `deprecated`: allow to set method as deprecated (default: `false`);
|
* `deprecated`: allow to set method as deprecated (default: `false`);
|
||||||
|
|
||||||
* `tags`: allow to tag a method (e.g. `beta` or `in-development`). Either a single tag or an array of tags.
|
* `tags`: allow to tag a method (e.g. `beta` or `in-development`). Either a single tag or an array of tags.
|
||||||
|
|
||||||
* `filters`: an array of filters;
|
* `filters`: an array of filters;
|
||||||
|
|
||||||
@ -412,23 +412,31 @@ Look at the built-in [Handlers](https://github.com/nelmio/NelmioApiDocBundle/tre
|
|||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
nelmio_api_doc:
|
nelmio_api_doc:
|
||||||
name: API documentation
|
name: 'API documentation'
|
||||||
exclude_sections: []
|
exclude_sections: []
|
||||||
motd:
|
motd:
|
||||||
template: NelmioApiDocBundle::Components/motd.html.twig
|
template: 'NelmioApiDocBundle::Components/motd.html.twig'
|
||||||
request_listener:
|
request_listener:
|
||||||
enabled: true
|
enabled: true
|
||||||
parameter: _doc
|
parameter: _doc
|
||||||
sandbox:
|
sandbox:
|
||||||
enabled: true
|
enabled: true
|
||||||
endpoint: ~
|
endpoint: null
|
||||||
accept_type: ~
|
accept_type: null
|
||||||
body_format: form
|
body_format:
|
||||||
|
formats:
|
||||||
|
|
||||||
|
# Defaults:
|
||||||
|
- form
|
||||||
|
- json
|
||||||
|
default_format: ~ # One of "form"; "json"
|
||||||
request_format:
|
request_format:
|
||||||
formats:
|
formats:
|
||||||
json: application/json
|
|
||||||
xml: application/xml
|
# Defaults:
|
||||||
method: format_param
|
json: application/json
|
||||||
|
xml: application/xml
|
||||||
|
method: ~ # One of "format_param"; "accept_header"
|
||||||
default_format: json
|
default_format: json
|
||||||
authentication:
|
authentication:
|
||||||
name: ~ # Required
|
name: ~ # Required
|
||||||
|
Loading…
x
Reference in New Issue
Block a user