Api Doc Bundle Laravel Package
nelmio/api-doc-bundle
Symfony bundle to generate OpenAPI documentation for your APIs. Provides an interactive docs UI and schema generation driven by PHP 8 attributes. Requires PHP 8.1+ and Symfony 6.4+. Includes migration guides and solid CI support.
NelmioApiDocBundle
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
License
How can I help you explore Laravel packages today?