oro / api-doc-bundle
nelmio/NelmioApiDocBundle 的分支,使其 2.x 版本与 Symfony 5 兼容
2.1.0
2023-09-13 11:08 UTC
Requires
- php: ~8.0
- michelf/php-markdown: ~1.9
- symfony/console: ~4.4|~5.3|~6.3
- symfony/framework-bundle: ~4.4|~5.3|~6.3
- symfony/twig-bundle: ~4.4|~5.3|~6.3
Suggests
- dunglas/api-bundle: For making use of resources definitions of DunglasApiBundle.
- friendsofsymfony/rest-bundle: For making use of REST information in the doc.
- jms/serializer: For making use of serializer information in the doc.
- symfony/form: For using form definitions as input.
- symfony/validator: For making use of validator information in the doc.
Conflicts
- jms/serializer: <0.12
- jms/serializer-bundle: <0.11
- twig/twig: <1.12
This package is auto-updated.
Last update: 2024-08-30 14:08:09 UTC
README
NelmioApiDocBundle 扩展允许您为您的 API 生成良好的文档。
文档
贡献
查看 CONTRIBUTING 文件。
运行测试
安装 Composer 的 dev
依赖
php composer.phar install --dev
然后,使用 PHPUnit 运行测试套件
phpunit
致谢
设计灵感主要来自 swagger-ui 项目。文档渲染使用了 Glyphicons 库的一些图标。
许可协议
本扩展程序遵循 MIT 许可协议发布。请查看扩展程序中的完整许可协议。
Resources/meta/LICENSE