oro/api-doc-bundle

Fork of nelmio/NelmioApiDocBundle to make 2.x version compatible with Symfony 5

2.2.0-rc 2026-05-26 14:11 UTC

Requires

• php: ~8.5
• michelf/php-markdown: ~1.9
• symfony/console: ~7.3
• symfony/form: ~7.3
• symfony/framework-bundle: ~7.3
• symfony/twig-bundle: ~7.3

Requires (Dev)

• doctrine/annotations: ~2.0
• friendsofsymfony/rest-bundle: ~3.8
• jms/serializer: ~3.32
• jms/serializer-bundle: ~5.5
• phpunit/phpunit: ~9.6
• symfony/browser-kit: ~7.3
• symfony/cache: ~7.3
• symfony/config: ~7.3
• symfony/css-selector: ~7.3
• symfony/dependency-injection: ~7.3
• symfony/dom-crawler: ~7.3
• symfony/error-handler: ~7.3
• symfony/event-dispatcher: ~7.3
• symfony/filesystem: ~7.3
• symfony/finder: ~7.3
• symfony/http-foundation: ~7.3
• symfony/http-kernel: ~7.3
• symfony/options-resolver: ~7.3
• symfony/property-access: ~7.3
• symfony/property-info: ~7.3
• symfony/routing: ~7.3
• symfony/string: ~7.3
• symfony/twig-bridge: ~7.3
• symfony/validator: ~7.3
• symfony/var-dumper: ~7.3
• symfony/var-exporter: ~7.3
• symfony/yaml: ~7.3

Suggests

• 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.

MIT

• Nelmio
• Symfony Community
• Oro Community

• documentation
• rest
• api
• doc

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