jlpoveda / api-doc-bundle
Generates documentation for your REST API from annotations and allow HMAC authentication in the sandbox
Installs: 894
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 835
Type:symfony-bundle
Requires
- php: >=5.3
- michelf/php-markdown: ~1.4
- symfony/console: ~2.3|~3.0
- symfony/framework-bundle: ~2.3|~3.0
- symfony/twig-bundle: ~2.3|~3.0
Requires (Dev)
- doctrine/doctrine-bundle: ~1.5
- doctrine/orm: ~2.3
- dunglas/api-bundle: ~2.0
- friendsofsymfony/rest-bundle: ~1.0|~2.0
- jms/serializer-bundle: >=0.11
- phpunit/phpunit: ^5.0
- sensio/framework-extra-bundle: ~3.0
- symfony/asset: ^3.2
- symfony/browser-kit: ~2.3|~3.0
- symfony/css-selector: ~2.3|~3.0
- symfony/finder: ~2.3|~3.0
- symfony/form: ~2.3|~3.0
- symfony/serializer: ~2.7|~3.0
- symfony/validator: ~2.3|~3.0
- symfony/yaml: ~2.3|~3.0
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
- symfony/symfony: ~2.7.8
- twig/twig: <1.12
- 2.14.10
- 2.14.9
- 2.14.8
- 2.14.7
- 2.14.6
- 2.14.5
- 2.14.4
- 2.14.3
- 2.14.2
- 2.14.1
- 2.14.0
- dev-master / 2.13.x-dev
- 2.13.0
- 2.12.0
- 2.11.2
- 2.11.1
- 2.11.0
- 2.10.3
- 2.10.2
- 2.10.1
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4.5
- 2.4.4
- 2.4.3
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.2
- 2.3.1
- 2.3.0
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.0
- 2.0.1
- 2.0.0
- 1.0.1
- 1.0.0
- dev-feature-mockserver-support
- dev-feature-authorization-by-view
- dev-bug-jwt
- dev-hotfix-hide-invalid-requirementes
- dev-hotfix-passing-tests
- dev-feature-allow-add-requirements
- dev-changing-namespaces
- dev-hotfix-readme-changed
This package is not auto-updated.
Last update: 2024-11-09 19:04:46 UTC
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