effiana / api-doc-bundle

从注解生成REST API的文档

维护者

详细信息

github.com/Effiana/NelmioApiDocBundle

类型:symfony-bundle

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.

Provides

None

Conflicts

symfony/framework-bundle: 4.2.7

Replaces

None

MIT 3d808dc20942cd67f0b4b479ed4203a786997f20

documentation rest api doc

This package is auto-updated.

Last update: 2024-09-29 05:28:59 UTC

README

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

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