Skip to content

Generates documentation for your REST API from annotations

License

Notifications You must be signed in to change notification settings

nelmio/NelmioApiDocBundle

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

71ffab7 · Aug 16, 2024
Aug 16, 2024
Jun 12, 2024
Jul 22, 2024
Apr 19, 2024
Aug 8, 2024
Apr 19, 2024
Aug 8, 2024
Jan 15, 2024
Mar 2, 2024
Apr 6, 2024
Apr 4, 2024
Mar 11, 2024
Apr 19, 2024
Jun 12, 2024
Dec 29, 2016
Jan 6, 2023
May 12, 2022
Feb 28, 2022
Aug 16, 2024
Apr 19, 2024
Apr 15, 2024
Feb 13, 2024
Apr 6, 2024
Jun 22, 2017

Repository files navigation

NelmioApiDocBundle

Build Status Total Downloads Latest Stable Version

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

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.

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

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:

./phpunit

License

This bundle is released under the MIT license.