通过
搜索
搜索igorladela / api-doc-bundle
从注释生成REST API的文档
2.8.0
2015-03-06 10:47 UTC
Requires
- michelf/php-markdown: ~1.4
- symfony/console: ~2.1
- symfony/framework-bundle: ~2.1
- symfony/twig-bundle: ~2.1
Requires (Dev)
- 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/validator: ~2.1
- symfony/yaml: ~2.1
Suggests
- 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