tireconnect/api-doc-bundle

Generates documentation for your REST API from annotations

Installs: 1 350

Dependents: 0

Suggesters: 0

Stars: 0

Watchers: 2

Forks: 695

Type:symfony-bundle


README

Build Status Total Downloads Latest Stable Version

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

Documentation

Read the documentation on symfony.com

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