smyler / api-doc-bundle
Generates documentation for your REST API from annotations
Installs: 594
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 844
Type:symfony-bundle
Requires
- php: ^7.0
- exsyst/swagger: ^0.4.1
- phpdocumentor/reflection-docblock: ^3.1|^4.0
- symfony/framework-bundle: ^3.4|^4.0
- symfony/options-resolver: ^3.4.4|^4.0
- symfony/property-info: ^3.4|^4.0
- zircote/swagger-php: ^2.0.9
Requires (Dev)
- api-platform/core: ^2.1.0
- doctrine/annotations: ^1.2
- doctrine/common: ^2.4
- friendsofsymfony/rest-bundle: ^2.0
- jms/serializer-bundle: ^2.0
- sensio/framework-extra-bundle: ^3.0
- symfony/asset: ^3.4|^4.0
- symfony/browser-kit: ^3.4|^4.0
- symfony/cache: ^3.4|^4.0
- symfony/config: ^3.4|^4.0
- symfony/console: ^3.4|^4.0
- symfony/dom-crawler: ^3.4|^4.0
- symfony/form: ^3.4|^4.0
- symfony/phpunit-bridge: ^3.4|^4.0
- symfony/property-access: ^3.4|^4.0
- symfony/stopwatch: ^3.4|^4.0
- symfony/templating: ^3.4|^4.0
- symfony/twig-bundle: ^3.4|^4.0
- symfony/validator: ^3.4|^4.0
- willdurand/hateoas-bundle: ^1.0
Suggests
- api-platform/core: For using an API oriented framework.
- friendsofsymfony/rest-bundle: For using the parameters annotations.
- dev-master
- 3.x-dev
- v3.3.0
- v3.2.1
- v3.2.0
- v3.1.0
- v3.0.0
- v3.0.0-BETA4
- v3.0.0-BETA3
- v3.0.0-BETA2
- v3.0.0-BETA1
- 2.x-dev
- 2.13.3
- 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
This package is not auto-updated.
Last update: 2025-03-04 15:21:51 UTC
README
The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
This fork is intented to provide specific support of the 2.x version for smyler needs
This include for now:
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