nelmio / api-doc-bundle

从注解和属性生成REST API的文档

维护者

详情

github.com/nelmio/NelmioApiDocBundle

资助包维护！
DjordyKoert

安装次数: 48,133,935

星星: 2,218

公开问题: 146

类型:symfony-bundle

v4.30.0 2024-09-14 10:54 UTC

Requires

php: >=7.4
ext-json: *
phpdocumentor/reflection-docblock: ^4.3.4 || ^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
composer/package-versions-deprecated: 1.11.99.1
doctrine/annotations: ^2.0
friendsofphp/php-cs-fixer: ^3.52
friendsofsymfony/rest-bundle: ^2.8 || ^3.0
jms/serializer: ^1.14 || ^3.0
jms/serializer-bundle: ^2.3 || ^3.0 || ^4.0 || ^5.0
phpstan/phpstan: ^1.10
phpstan/phpstan-phpunit: ^1.3
phpstan/phpstan-strict-rules: ^1.5
phpstan/phpstan-symfony: ^1.3
phpunit/phpunit: ^9.6 || ^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-bundle: ^1.0 || ^2.0

Suggests

api-platform/core: For using an API oriented framework.
doctrine/annotations: For using doctrine annotations
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 277fa17b912be31b5170e49f0924b1028058c938

Symfony Community

documentation rest api doc

This package is auto-updated.

Last update: 2024-09-14 10:55:09 UTC

README

NelmioApiDocBundle 包允许您为API生成不错的文档。

从3.x迁移到4.0

要从3.x迁移到4.0，请按照我们的指南操作。

版本4.0引入了对OpenAPI 3.0的支持。如果您想坚持使用Swagger 2.0，则应使用此包的3.0版本。

从2.x迁移到3.0

要从2.x迁移到3.0，请按照我们的指南操作。

安装

打开命令行，进入您的项目目录，并执行以下命令以下载此包的最新版本

composer require nelmio/api-doc-bundle

文档

在symfony.com上阅读文档

贡献

查看 CONTRIBUTING 文件。

运行测试

安装 Composer 依赖

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

然后运行测试套件

./phpunit

许可证

此包在MIT许可证下发布。