通过
搜索
搜索muchar / api-doc-bundle
从注释生成REST API的文档
2.13.0
2016-06-13 09:12 UTC
Requires
- php: >=5.3
- michelf/php-markdown: ~1.4
- symfony/console: ~2.3|~3.0
- symfony/framework-bundle: ~2.3|~3.0
- symfony/twig-bundle: ~2.3|~3.0
Requires (Dev)
- doctrine/doctrine-bundle: ~1.5
- doctrine/orm: ~2.3
- dunglas/api-bundle: ~1.0@dev
- friendsofsymfony/rest-bundle: ~1.0|~2.0
- jms/serializer-bundle: >=0.11
- sensio/framework-extra-bundle: ~3.0
- symfony/browser-kit: ~2.3|~3.0
- symfony/css-selector: ~2.3|~3.0
- symfony/finder: ~2.3|~3.0
- symfony/form: ~2.3|~3.0
- symfony/phpunit-bridge: ~2.7|~3.0
- symfony/serializer: ~2.7|~3.0
- symfony/validator: ~2.3|~3.0
- symfony/yaml: ~2.3|~3.0
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
- symfony/symfony: ~2.7.8
- twig/twig: <1.12
This package is not auto-updated.
Last update: 2024-09-23 13:28:41 UTC
README
NelmioApiDocBundle 包允许您为API生成良好的文档。
文档
有关文档，请参阅
Resources/doc/
贡献
参见CONTRIBUTING 文件。
运行测试
安装dev依赖项Composer
php composer.phar install --dev
然后，使用PHPUnit运行测试套件
phpunit
致谢
设计受到swagger-ui项目的很大启发。文档中使用了Glyphicons库中的某些图标。
许可证
此包在MIT许可证下发布。请参阅包中的完整许可证。
Resources/meta/LICENSE