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

Added configuration reference.

Browse Source
This commit is contained in:
Bez Hermoso 2014-06-25 14:20:30 -07:00 committed by Bez Hermoso
parent cfe6cbc134
commit 04818b00e5
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Resources/doc/swagger-support.md
View File

@ -97,3 +97,20 @@ Dump a specific resource API declaration only:
php app/console api:swagger:dump --resource=users php app/console api:swagger:dump --resource=users
``` ```
The above command will dump the `/users` API declaration in an `users.json` file. The above command will dump the `/users` API declaration in an `users.json` file.
##Configuration reference
```yml
nelmio_api_doc:
swagger:
api_base_path: /api
swagger_version: 1.2
api_version: 0.1
info:
title: Symfony2
description: My awesome Symfony2 app!
TermsOfServiceUrl: ~
contact: ~
license: ~
licenseUrl: ~
```