nelmio/api-doc-bundle

Generates documentation for your REST API from attributes

v5.0.1 2025-03-24 15:14 UTC

Requires

• php: >=8.1
• ext-json: *
• phpdocumentor/reflection-docblock: ^5.0
• phpdocumentor/type-resolver: ^1.8.2
• psr/cache: ^1.0 || ^2.0 || ^3.0
• psr/container: ^1.0 || ^2.0
• psr/log: ^1.0 || ^2.0 || ^3.0
• symfony/config: ^6.4 || ^7.1
• symfony/console: ^6.4 || ^7.1
• symfony/dependency-injection: ^6.4 || ^7.1
• symfony/deprecation-contracts: ^2.1 || ^3
• symfony/framework-bundle: ^6.4 || ^7.1
• symfony/http-foundation: ^6.4 || ^7.1
• symfony/http-kernel: ^6.4 || ^7.1
• symfony/options-resolver: ^6.4 || ^7.1
• symfony/property-info: ^6.4 || ^7.1
• symfony/routing: ^6.4 || ^7.1
• zircote/swagger-php: ^4.11.1 || ^5.0

Requires (Dev)

• api-platform/core: ^3.2
• friendsofphp/php-cs-fixer: ^3.52
• friendsofsymfony/rest-bundle: ^3.2.0
• jms/serializer: ^3.32
• jms/serializer-bundle: ^5.5
• phpstan/phpstan: ^1.10
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-strict-rules: ^1.5
• phpstan/phpstan-symfony: ^1.3
• phpunit/phpunit: ^10.5
• symfony/asset: ^6.4 || ^7.1
• symfony/browser-kit: ^6.4 || ^7.1
• symfony/cache: ^6.4 || ^7.1
• symfony/dom-crawler: ^6.4 || ^7.1
• symfony/expression-language: ^6.4 || ^7.1
• symfony/form: ^6.4 || ^7.1
• symfony/phpunit-bridge: ^6.4 || ^7.1
• symfony/property-access: ^6.4 || ^7.1
• symfony/security-csrf: ^6.4 || ^7.1
• symfony/serializer: ^6.4 || ^7.1
• symfony/stopwatch: ^6.4 || ^7.1
• symfony/templating: ^6.4 || ^7.1
• symfony/twig-bundle: ^6.4 || ^7.1
• symfony/uid: ^6.4 || ^7.1
• symfony/validator: ^6.4 || ^7.1
• willdurand/hateoas-bundle: ^2.7
• willdurand/negotiation: ^3.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/security-csrf: For using csrf protection tokens in forms.
• symfony/serializer: For describing your models.
• symfony/twig-bundle: For using the Swagger UI.
• symfony/validator: For describing the validation constraints in your models.
• willdurand/hateoas-bundle: For extracting HATEOAS metadata.

Conflicts

• zircote/swagger-php: 4.8.7

MIT

• Symfony Community

• documentation
• rest
• api
• doc

README

The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.

Installation

Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:

composer require nelmio/api-doc-bundle

Documentation

Read the documentation on symfony.com

Migrate from 4.x to 5.0

To migrate from 4.x to 5.0, follow our guide.

This version comes with the following major changes:

• The bundle now requires PHP 8.1 or higher.
• Support for annotations has been removed in favor of PHP 8 attributes.
• Minimum Symfony version is now 6.4.
• Major cleanup and simplification of the codebase.

Migrate from 3.x to 4.0

To migrate from 3.x to 4.0, follow our guide.

Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.

Migrate from 2.x to 3.0

To migrate from 2.x to 3.0, follow our guide.

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dependencies:

git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update

Then run the test suite:

composer phpunit

Sponsored by

JetBrains sponsors this project by providing an open-source license for their tools.

License

This bundle is released under the MIT license.