effiana/api-doc-bundle

Generates documentation for your REST API from annotations

v3.5.1 2019-12-02 08:53 UTC

Requires

• php: ^7.1
• exsyst/swagger: ^0.4.1
• phpdocumentor/reflection-docblock: ^3.1|^4.0
• symfony/framework-bundle: ^3.4|^4.0|^5.0
• symfony/options-resolver: ^3.4.4|^4.0|^5.0
• symfony/property-info: ^3.4|^4.0|^5.0
• zircote/swagger-php: ^2.0.9

Requires (Dev)

• api-platform/core: ^2.1.2
• doctrine/annotations: ^1.2
• doctrine/common: ^2.4
• friendsofsymfony/rest-bundle: ^2.0
• jms/serializer: ^1.14|^3.0
• jms/serializer-bundle: ^2.3|^3.0
• sensio/framework-extra-bundle: ^3.0.13|^4.0|^5.0
• symfony/asset: ^3.4|^4.0|^5.0
• symfony/browser-kit: ^3.4|^4.0|^5.0
• symfony/cache: ^3.4|^4.0|^5.0
• symfony/config: ^3.4|^4.0|^5.0
• symfony/console: ^3.4|^4.0|^5.0
• symfony/dom-crawler: ^3.4|^4.0|^5.0
• symfony/form: ^3.4|^4.0|^5.0
• symfony/phpunit-bridge: ^3.4.24|^4.0|^5.0
• symfony/property-access: ^3.4|^4.0|^5.0
• symfony/routing: ^3.4|^4.0|^5.0
• symfony/stopwatch: ^3.4|^4.0|^5.0
• symfony/templating: ^3.4|^4.0|^5.0
• symfony/twig-bundle: ^3.4|^4.0|^5.0
• symfony/validator: ^3.4|^4.0|^5.0
• willdurand/hateoas-bundle: ^1.0|^2.0

Suggests

• api-platform/core: For using an API oriented framework.
• friendsofsymfony/rest-bundle: For using the parameters annotations.

Conflicts

• symfony/framework-bundle: 4.2.7

MIT

• Nelmio
• Symfony Community

• documentation
• rest
• api
• doc

README

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

Migrate from 2.x to 3.0

To migrate from 2.x to 3.0, follow our guide.

Installation

Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:

composer require nelmio/api-doc-bundle

Documentation

Read the documentation on symfony.com

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dependencies:

git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.