streamlike / api-doc-bundle

从注释生成REST API文档

维护者

详细信息

github.com/Streamlike/NelmioApiDocBundle

安装次数: 3,679

类型:symfony-bundle

v4.9.0 2022-04-30 18:28 UTC

Requires

php: >=7.2
ext-json: *
doctrine/annotations: ^1.11
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: ^3.2|^4.0

Requires (Dev)

api-platform/core: ^2.6.8
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
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/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/validator: For describing the validation constraints in your models.
twig/twig-bundle: For using the Swagger UI.
willdurand/hateoas-bundle: For extracting HATEOAS metadata.

Provides

None

Conflicts

symfony/framework-bundle: 4.2.7

Replaces

None

MIT da02f3ad339437b939a6d309e9c98b62afe53c6c

documentation rest api doc

This package is auto-updated.

Last update: 2024-09-24 17:57:56 UTC

README

NelmioApiDocBundle扩展包允许您生成高质量的API文档。

文档

在symfony.com上阅读文档

贡献

查看CONTRIBUTING文件。

运行测试

安装Composer的dev依赖

php composer.phar install --dev

然后，使用PHPUnit运行测试套件

phpunit

鸣谢

设计灵感主要来源于swagger-ui项目。文档中使用了Glyphicons库的一些图标。

许可证

此扩展包采用MIT许可证发布。请参阅扩展包中的完整许可证。

Resources/meta/LICENSE