avaibook-nelmio / api-doc-bundle

从注释生成您的REST API文档

维护者

详细信息

github.com/avaibook/NelmioApiDocBundle

类型:symfony-bundle

v4.11.1 2023-02-01 07:18 UTC

Requires

php: >=7.2
ext-json: *
doctrine/annotations: ^1.11|^2.0
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/property-info: ^4.4|^5.0|^6.0
symfony/routing: ^4.4|^5.0|^6.0
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/serializer: ^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
symfony/validator: ^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.

Provides

None

Conflicts

symfony/framework-bundle: 4.2.7

Replaces

None

MIT d40c4eb0c090675f3685f75712af331f02924462

documentation rest api doc

This package is not auto-updated.

Last update: 2024-09-20 21:30:32 UTC

README

NelmioApiDocBundle 插件允许您为API生成合理的文档。

从3.x迁移到4.0

要从3.x迁移到4.0，请遵循我们的指南。

版本4.0引入了对OpenAPI 3.0的支持。如果您想坚持使用Swagger 2.0，应使用此插件的3.x版本。

从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许可证下发布。