Skip to content

Generates documentation for your REST API from annotations

Notifications You must be signed in to change notification settings

damien-thiesson/NelmioApiDocBundle

 
 

Repository files navigation

NelmioApiDocBundle

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

About

Generates documentation for your REST API from annotations

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 92.1%
  • HTML 6.3%
  • CSS 1.6%