nelmio/api-doc-bundle

Generates documentation for your REST API from annotations

Installs: 13 062 723

Dependents: 245

Suggesters: 27

Stars: 1 677

Watchers: 74

Forks: 676

Open Issues: 64

Type:symfony-bundle

v3.4.0 2019-02-18 16:27 UTC

README

Build Status Total Downloads Latest Stable Version

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

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.