Repository files navigation

TheNelmioApiDocBundle bundle allows you to generate a decent documentationfor 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.

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.

SeeCONTRIBUTINGfile.

Install theComposer dependencies:

git clone https://github.com/nelmio/NelmioApiDocBundle.gitcd NelmioApiDocBundlecomposer update

Then run the test suite:

composer phpunit

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

This bundle is released under the MIT license.