streamlike / api-doc-bundle
Generates documentation for your REST API from annotations
Maintainers
Package info
github.com/Streamlike/NelmioApiDocBundle
Type:symfony-bundle
pkg:composer/streamlike/api-doc-bundle
Requires
- php: >=7.2
- ext-json: *
- doctrine/annotations: ^1.11
- phpdocumentor/reflection-docblock: ^3.1|^4.0|^5.0
- psr/cache: ^1.0|^2.0|^3.0
- psr/container: ^1.0|^2.0
- psr/log: ^1.0|^2.0|^3.0
- symfony/config: ^4.4|^5.0|^6.0
- symfony/console: ^4.4|^5.0|^6.0
- symfony/dependency-injection: ^4.4|^5.0|^6.0
- symfony/framework-bundle: ^4.4|^5.0|^6.0
- symfony/http-foundation: ^4.4|^5.0|^6.0
- symfony/http-kernel: ^4.4|^5.0|^6.0
- symfony/options-resolver: ^4.4|^5.0|^6.0
- symfony/property-info: ^4.4|^5.0|^6.0
- symfony/routing: ^4.4|^5.0|^6.0
- zircote/swagger-php: ^3.2|^4.0
Requires (Dev)
- api-platform/core: ^2.6.8
- composer/package-versions-deprecated: 1.11.99.1
- friendsofsymfony/rest-bundle: ^2.8|^3.0
- jms/serializer: ^1.14|^3.0
- jms/serializer-bundle: ^2.3|^3.0|^4.0
- sensio/framework-extra-bundle: ^4.4|^5.2|^6.0
- symfony/asset: ^4.4|^5.2|^6.0
- symfony/browser-kit: ^4.4|^5.2|^6.0
- symfony/cache: ^4.4|^5.2|^6.0
- symfony/dom-crawler: ^4.4|^5.2|^6.0
- symfony/form: ^4.4|^5.2|^6.0
- symfony/phpunit-bridge: ^5.2
- symfony/property-access: ^4.4|^5.2|^6.0
- symfony/serializer: ^4.4|^5.2|^6.0
- symfony/stopwatch: ^4.4|^5.2|^6.0
- symfony/templating: ^4.4|^5.2|^6.0
- symfony/twig-bundle: ^4.4|^5.2|^6.0
- symfony/validator: ^4.4|^5.2|^6.0
- willdurand/hateoas-bundle: ^1.0|^2.0
Suggests
- api-platform/core: For using an API oriented framework.
- friendsofsymfony/rest-bundle: For using the parameters annotations.
- jms/serializer-bundle: For describing your models.
- symfony/asset: For using the Swagger UI.
- symfony/cache: For using a PSR-6 compatible cache implementation with the API doc generator.
- symfony/form: For describing your form type models.
- symfony/monolog-bundle: For using a PSR-3 compatible logger implementation with the API PHP describer.
- symfony/serializer: For describing your models.
- symfony/validator: For describing the validation constraints in your models.
- twig/twig-bundle: For using the Swagger UI.
- willdurand/hateoas-bundle: For extracting HATEOAS metadata.
Conflicts
- symfony/framework-bundle: 4.2.7
This package is auto-updated.
Last update: 2026-05-24 21:32:27 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