jlpoveda/api-doc-bundle

Generates documentation for your REST API from annotations and allow HMAC authentication in the sandbox

Installs: 890

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 696

Type:symfony-bundle

2.14.10 2017-03-26 22:40 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