tireconnect/api-doc-bundle

This package is abandoned and no longer maintained. The author suggests using the nelmio/api-doc-bundle package instead.

Generates documentation for your REST API from annotations

v3.0.0-BETA4 2017-07-25 09:26 UTC

Requires

• php: ~7.0|~7.1
• exsyst/swagger: ~0.3
• symfony/framework-bundle: ^3.2.5|^4.0
• symfony/property-info: ^3.1|^4.0
• zircote/swagger-php: ^2.0.9

Requires (Dev)

• api-platform/core: ^2.0.3
• doctrine/annotations: ^1.2
• friendsofsymfony/rest-bundle: ^2.0
• jms/serializer-bundle: ^1.0|^2.0
• phpdocumentor/reflection-docblock: ^3.1
• sensio/framework-extra-bundle: ^3.0
• symfony/asset: ^2.8|^3.0|^4.0
• symfony/browser-kit: ^2.8|^3.0|^4.0
• symfony/cache: ^3.1|^4.0
• symfony/config: ^2.8|^3.0|^4.0
• symfony/console: ^2.8|^3.0|^4.0
• symfony/dom-crawler: ^2.8|^3.0|^4.0
• symfony/form: ^3.0.8|^4.0
• symfony/phpunit-bridge: ^3.3
• symfony/property-access: ^2.8|^3.0|^4.0
• symfony/templating: ^2.8|^3.0|^4.0
• symfony/twig-bundle: ^3.0|^4.0
• symfony/validator: ^2.8|^3.0|^4.0

Suggests

• api-platform/core: For using an API oriented framework.
• friendsofsymfony/rest-bundle: For using the parameters annotations.
• phpdocumentor/reflection-docblock: For parsing php docs.

MIT

• Nelmio
• Symfony Community

• documentation
• rest
• api
• doc

README

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