mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-04-01 21:06:15 +03:00
Generates documentation for your REST API from annotations
b3c53beead
* Add dump command to print out swagger JSON. Command outputs to stdout, so can be redirected to a file. Pretty prints output by default. --no-pretty can be passed to remove whitespace from json output if it does not need to be human readable * Update for styleci corrections * Fix CS and add type hint * REbase + Updates to documentation of dump command. * Remove defaultName - config file specifies this Add return value to dump command * Update for OA3 * Add a test case * update command name * Fix the tests Co-authored-by: Guilhem Niot <egetick@gmail.com> Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com> |
||
|---|---|---|
| Annotation | ||
| Command | ||
| Controller | ||
| DependencyInjection | ||
| Describer | ||
| Form/Extension | ||
| Model | ||
| ModelDescriber | ||
| OpenApiPhp | ||
| PropertyDescriber | ||
| Resources | ||
| RouteDescriber | ||
| Routing | ||
| Tests | ||
| Util | ||
| .gitignore | ||
| .php_cs.dist | ||
| .styleci.yml | ||
| .travis.yml | ||
| ApiDocGenerator.php | ||
| CHANGELOG.md | ||
| composer.json | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| NelmioApiDocBundle.php | ||
| phpunit | ||
| phpunit.xml.dist | ||
| README.md | ||
| update-js.sh | ||
| UPGRADE-3.0.md | ||
| UPGRADE-4.0.md | ||
NelmioApiDocBundle
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
Migrate from 3.x to 4.0
To migrate from 3.x to 4.0, follow our guide.
Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.
Migrate from 2.x to 3.0
To migrate from 2.x to 3.0, follow our guide.
Installation
Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:
composer require nelmio/api-doc-bundle
Documentation
Read the documentation on symfony.com
Contributing
See CONTRIBUTING file.
Running the Tests
Install the Composer dependencies:
git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update
Then run the test suite:
./phpunit
License
This bundle is released under the MIT license.