nzo / api-doc-bundle
从注释生成REST API的文档
2.9.0
2015-05-16 17:16 UTC
Requires
- michelf/php-markdown: ~1.4
- symfony/console: ~2.1
- symfony/framework-bundle: ~2.1
- symfony/twig-bundle: ~2.1
Requires (Dev)
- dunglas/api-bundle: dev-master
- friendsofsymfony/rest-bundle: ~1.0
- jms/serializer-bundle: >=0.11
- sensio/framework-extra-bundle: ~3.0
- symfony/browser-kit: ~2.1
- symfony/css-selector: ~2.1
- symfony/form: ~2.1
- symfony/serializer: ~2.7@dev
- symfony/validator: ~2.1
- symfony/yaml: ~2.1
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
README
NelmioApiDocBundle 包允许您为您的API生成合理的文档。
文档
有关文档,请参阅
Resources/doc/
贡献
查看 CONTRIBUTING 文件。
运行测试
安装 Composer 的 dev
依赖
php composer.phar install --dev
然后,使用 PHPUnit 运行测试套件
phpunit
致谢
设计灵感主要来自 swagger-ui 项目。文档中使用了 Glyphicons 库中的某些图标。
许可证
此包以MIT许可证发布。请参阅包中的完整许可证。
Resources/meta/LICENSE