tireconnect / api-doc-bundle
Generates documentation for your REST API from annotations
Installs: 3 376
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 715
Type:symfony-bundle
Requires
- php: ~7.0|~7.1
- exsyst/swagger: ~0.3
- symfony/framework-bundle: ^3.2.5|^4.0
- symfony/property-info: ^3.1|^4.0
- zircote/swagger-php: ^2.0.9
Requires (Dev)
- api-platform/core: ^2.0.3
- doctrine/annotations: ^1.2
- friendsofsymfony/rest-bundle: ^2.0
- jms/serializer-bundle: ^1.0|^2.0
- phpdocumentor/reflection-docblock: ^3.1
- sensio/framework-extra-bundle: ^3.0
- symfony/asset: ^2.8|^3.0|^4.0
- symfony/browser-kit: ^2.8|^3.0|^4.0
- symfony/cache: ^3.1|^4.0
- symfony/config: ^2.8|^3.0|^4.0
- symfony/console: ^2.8|^3.0|^4.0
- symfony/dom-crawler: ^2.8|^3.0|^4.0
- symfony/form: ^3.0.8|^4.0
- symfony/phpunit-bridge: ^3.3
- symfony/property-access: ^2.8|^3.0|^4.0
- symfony/templating: ^2.8|^3.0|^4.0
- symfony/twig-bundle: ^3.0|^4.0
- symfony/validator: ^2.8|^3.0|^4.0
Suggests
- api-platform/core: For using an API oriented framework.
- friendsofsymfony/rest-bundle: For using the parameters annotations.
- phpdocumentor/reflection-docblock: For parsing php docs.
- dev-master / 3.0.x-dev
- v3.0.0-BETA4
- v3.0.0-BETA3
- v3.0.0-BETA2
- v3.0.0-BETA1
- 2.x-dev
- 2.14.2
- 2.14.1
- 2.14.0
- 2.13.2
- 2.13.1
- 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-test
- dev-ui
This package is not auto-updated.
Last update: 2020-12-21 14:53:04 UTC
README
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
Documentation
Read the documentation on symfony.com
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