The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.
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
Read the documentation on symfony.com
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.
The bundle also runs under FrankenPHP worker mode and other long-running workers, see FrankenPHP and long-running workers.
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.
To migrate from 2.x to 3.0, follow our guide.
See CONTRIBUTING file.
Install the Composer dependencies:
git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update
Then run the test suite:
composer phpunit
JetBrains sponsors this project by providing an open-source license for their tools.