jlpoveda/api-doc-bundle

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

2.14.10 2017-03-26 22:40 UTC

Requires

• php: >=5.3
• michelf/php-markdown: ~1.4
• symfony/console: ~2.3|~3.0
• symfony/framework-bundle: ~2.3|~3.0
• symfony/twig-bundle: ~2.3|~3.0

Requires (Dev)

• doctrine/doctrine-bundle: ~1.5
• doctrine/orm: ~2.3
• dunglas/api-bundle: ~2.0
• friendsofsymfony/rest-bundle: ~1.0|~2.0
• jms/serializer-bundle: >=0.11
• phpunit/phpunit: ^5.0
• sensio/framework-extra-bundle: ~3.0
• symfony/asset: ^3.2
• symfony/browser-kit: ~2.3|~3.0
• symfony/css-selector: ~2.3|~3.0
• symfony/finder: ~2.3|~3.0
• symfony/form: ~2.3|~3.0
• symfony/serializer: ~2.7|~3.0
• symfony/validator: ~2.3|~3.0
• symfony/yaml: ~2.3|~3.0

Suggests

• dunglas/api-bundle: For making use of resources definitions of DunglasApiBundle.
• friendsofsymfony/rest-bundle: For making use of REST information in the doc.
• jms/serializer: For making use of serializer information in the doc.
• symfony/form: For using form definitions as input.
• symfony/validator: For making use of validator information in the doc.

Conflicts

• jms/serializer: <0.12
• jms/serializer-bundle: <0.11
• symfony/symfony: ~2.7.8
• twig/twig: <1.12

MIT

• Nelmio
• Symfony Community
• jlpoveda

• documentation
• rest
• api
• doc

README

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