elenyum/api-doc-bundle

Generates module structure for your REST API and documentation from annotations

v1.0.0 2023-01-09 19:33 UTC

Requires

• php: >=7.2
• ext-json: *
• doctrine/annotations: ^1.11
• doctrine/doctrine-bundle: ^2.7
• doctrine/doctrine-migrations-bundle: ^3.2
• doctrine/orm: ^2.13
• phpdocumentor/reflection-docblock: ^3.1|^4.0|^5.0
• psr/cache: ^1.0|^2.0|^3.0
• psr/container: ^1.0|^2.0
• psr/log: ^1.0|^2.0|^3.0
• symfony/config: ^4.4|^5.0|^6.0
• symfony/console: ^4.4|^5.0|^6.0
• symfony/dependency-injection: ^4.4|^5.0|^6.0
• symfony/framework-bundle: ^4.4|^5.0|^6.0
• symfony/http-foundation: ^4.4|^5.0|^6.0
• symfony/http-kernel: ^4.4|^5.0|^6.0
• symfony/options-resolver: ^4.4|^5.0|^6.0
• symfony/process: ^4.4|^5.2|^6.0
• symfony/property-info: ^4.4|^5.0|^6.0
• symfony/routing: ^4.4|^5.0|^6.0
• symfony/security-bundle: ^4.4|^5.2|^6.0
• symfony/serializer: ^4.4|^5.2|^6.0
• symfony/validator: ^4.4|^5.2|^6.0
• symfonycasts/reset-password-bundle: ^1.16
• zircote/swagger-php: ^4.2.15

Requires (Dev)

• api-platform/core: ^2.7.0|^3@dev
• composer/package-versions-deprecated: 1.11.99.1
• friendsofsymfony/rest-bundle: ^2.8|^3.0
• jms/serializer: ^1.14|^3.0
• jms/serializer-bundle: ^2.3|^3.0|^4.0|^5.0@beta
• sensio/framework-extra-bundle: ^4.4|^5.2|^6.0
• symfony/asset: ^4.4|^5.2|^6.0
• symfony/browser-kit: ^4.4|^5.2|^6.0
• symfony/cache: ^4.4|^5.2|^6.0
• symfony/deprecation-contracts: ^2.1|^3
• symfony/dom-crawler: ^4.4|^5.2|^6.0
• symfony/form: ^4.4|^5.2|^6.0
• symfony/phpunit-bridge: ^5.2
• symfony/property-access: ^4.4|^5.2|^6.0
• symfony/stopwatch: ^4.4|^5.2|^6.0
• symfony/templating: ^4.4|^5.2|^6.0
• symfony/twig-bundle: ^4.4|^5.2|^6.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.
• jms/serializer-bundle: For describing your models.
• symfony/asset: For using the Swagger UI.
• symfony/cache: For using a PSR-6 compatible cache implementation with the API doc generator.
• symfony/form: For describing your form type models.
• symfony/monolog-bundle: For using a PSR-3 compatible logger implementation with the API PHP describer.
• symfony/serializer: For describing your models.
• symfony/twig-bundle: For using the Swagger UI.
• symfony/validator: For describing the validation constraints in your models.
• willdurand/hateoas-bundle: For extracting HATEOAS metadata.

Conflicts

• symfony/framework-bundle: 4.2.7

MIT

• Elenyum

• documentation
• rest
• api
• doc

README

The ElenyumApiDocBundle bundle allows you to create module structure and generate a decent documentation for your APIs.

Installation

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

composer require elenyum/api-doc-bundle

Documentation

Running the Tests

Install the Composer dependencies:

git clone https://github.com/app-elenyum/ElenyumApiDocBundle.git
cd ElenyumApiDocBundle
composer update

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.