通过以下链接搜索 
corponat / api-doc-bundle
从注解和属性生成REST API的文档
v0.1.6
2023-06-14 14:27 UTC
Requires
- php: >=8.1
- 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.
Conflicts
- symfony/framework-bundle: 4.2.7
README
NelmioApiDocBundle 扩展允许您生成API的适当文档。
从3.x迁移到4.0
版本4.0带来了OpenAPI 3.0支持。如果您想坚持使用Swagger 2.0，您应该使用此扩展的3.0版本。
从2.x迁移到3.0
安装
打开命令行，进入您的项目目录，然后执行以下命令以下载此扩展的最新版本
composer require nelmio/api-doc-bundle
文档
贡献
请参阅CONTRIBUTING 文件。
运行测试
安装Composer 依赖项
git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update
然后运行测试套件
./phpunit
许可
此扩展在MIT许可下发布。