nelmio/api-doc-bundle

Generates documentation for your REST API from annotations

Installs: 3 035 877

Dependents: 174

Stars: 1 030

Watchers: 65

Forks: 448

Open Issues: 145

Type: symfony-bundle

2.12.0 2016-03-21 11:19 UTC

README

Build Status Total Downloads Latest Stable Version

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

Documentation

For documentation, see:

Resources/doc/

Read the documentation

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dev dependencies:

php composer.phar install --dev

Then, run the test suite using PHPUnit:

phpunit

Credits

The design is heavily inspired by the swagger-ui project. Some icons from the Glyphicons library are used to render the documentation.

License

This bundle is released under the MIT license. See the complete license in the bundle:

Resources/meta/LICENSE