nzo / api-doc-bundle
Generates documentation for your REST API from annotations
Installs: 267
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 836
Type:symfony-bundle
Requires
- michelf/php-markdown: ~1.4
- symfony/console: ~2.1
- symfony/framework-bundle: ~2.1
- symfony/twig-bundle: ~2.1
Requires (Dev)
- dunglas/api-bundle: dev-master
- friendsofsymfony/rest-bundle: ~1.0
- jms/serializer-bundle: >=0.11
- sensio/framework-extra-bundle: ~3.0
- symfony/browser-kit: ~2.1
- symfony/css-selector: ~2.1
- symfony/form: ~2.1
- symfony/serializer: ~2.7@dev
- symfony/validator: ~2.1
- symfony/yaml: ~2.1
Suggests
- dunglas/api-bundle: For making use of resources definitions of DunglasApiBundle.
- friendsofsymfony/rest-bundle: For making use of REST information in the doc.
- jms/serializer: For making use of serializer information in the doc.
- symfony/form: For using form definitions as input.
- symfony/validator: For making use of validator information in the doc.
Conflicts
- jms/serializer: <0.12
- jms/serializer-bundle: <0.11
README
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
Documentation
For documentation, see:
Resources/doc/
Contributing
See CONTRIBUTING file.
Running the Tests
Install the Composer dev dependencies:
php composer.phar install --dev
Then, run the test suite using PHPUnit:
phpunit
Credits
The design is heavily inspired by the swagger-ui project. Some icons from the Glyphicons library are used to render the documentation.
License
This bundle is released under the MIT license. See the complete license in the bundle:
Resources/meta/LICENSE