nelmio / api-doc-bundle

Generates documentation for your REST API from annotations and attributes

Maintainers

Details

github.com/nelmio/NelmioApiDocBundle

Fund package maintenance!
DjordyKoert

Installs: 49 232 948

Dependents: 305

Stars: 2 227

Forks: 834

Open Issues: 148

Type:symfony-bundle

v5.0.0-beta1 2024-10-25 14:25 UTC

Requires

php: >=8.1
ext-json: *
phpdocumentor/reflection-docblock: ^5.0
phpdocumentor/type-resolver: ^1.8.2
psr/cache: ^1.0 || ^2.0 || ^3.0
psr/container: ^1.0 || ^2.0
psr/log: ^1.0 || ^2.0 || ^3.0
symfony/config: ^5.4 || ^6.4 || ^7.0
symfony/console: ^5.4 || ^6.4 || ^7.0
symfony/dependency-injection: ^5.4 || ^6.4 || ^7.0
symfony/deprecation-contracts: ^2.1 || ^3
symfony/framework-bundle: ^5.4.24 || ^6.4 || ^7.0
symfony/http-foundation: ^5.4 || ^6.4 || ^7.0
symfony/http-kernel: ^5.4 || ^6.4 || ^7.0
symfony/options-resolver: ^5.4 || ^6.4 || ^7.0
symfony/property-info: ^5.4.10 || ^6.4 || ^7.0
symfony/routing: ^5.4 || ^6.4 || ^7.0
zircote/swagger-php: ^4.6.1

Requires (Dev)

api-platform/core: ^2.7.0 || ^3
friendsofphp/php-cs-fixer: ^3.52
friendsofsymfony/rest-bundle: ^3.2.0
jms/serializer: ^3.0
jms/serializer-bundle: ^5.2
phpstan/phpstan: ^1.10
phpstan/phpstan-phpunit: ^1.3
phpstan/phpstan-strict-rules: ^1.5
phpstan/phpstan-symfony: ^1.3
phpunit/phpunit: ^10.5
symfony/asset: ^5.4 || ^6.4 || ^7.0
symfony/browser-kit: ^5.4 || ^6.4 || ^7.0
symfony/cache: ^5.4 || ^6.4 || ^7.0
symfony/dom-crawler: ^5.4 || ^6.4 || ^7.0
symfony/expression-language: ^5.4 || ^6.4 || ^7.0
symfony/form: ^5.4 || ^6.4 || ^7.0
symfony/phpunit-bridge: ^6.4
symfony/property-access: ^5.4 || ^6.4 || ^7.0
symfony/security-csrf: ^5.4 || ^6.4 || ^7.0
symfony/serializer: ^5.4 || ^6.4 || ^7.0
symfony/stopwatch: ^5.4 || ^6.4 || ^7.0
symfony/templating: ^5.4 || ^6.4 || ^7.0
symfony/twig-bundle: ^5.4 || ^6.4 || ^7.0
symfony/uid: ^5.4 || ^6.4 || ^7.0
symfony/validator: ^5.4 || ^6.4 || ^7.0
willdurand/hateoas: ^3.11@beta
willdurand/hateoas-bundle: ^2.7@beta
willdurand/negotiation: ^3.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/security-csrf: For using csrf protection tokens in forms.
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.

Provides

None

Conflicts

zircote/swagger-php: 4.8.7

Replaces

None

MIT b2eea4f9716be1e2664359231af1558172d7c59f

Symfony Community

documentation rest api doc

This package is auto-updated.

Last update: 2024-11-01 14:18:42 UTC

README

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

Migrate from 3.x to 4.0

To migrate from 3.x to 4.0, follow our guide.

Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.

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.