通过
搜索
搜索rezzza / jadd
Jadd : 另一个文档导出工具
dev-master
2017-02-05 17:59 UTC
Requires
- php-di/php-di: ^5.3
- psr/http-message: ^1.0
- symfony/config: ^3.1
- symfony/console: ^3.0
- symfony/routing: ^3.1
- symfony/yaml: ^3.1
Requires (Dev)
- atoum/atoum: ^2.8
- behat/behat: ^3.1
- guzzlehttp/psr7: ^1.3
- php-http/client-common: ^1.2
- php-http/curl-client: ^1.5
- rezzza/moco-behat-extension: ^1.0
- rezzza/rest-api-behat-extension: ^5.0
- symfony/process: ^3.1
This package is not auto-updated.
Last update: 2024-09-14 19:20:14 UTC
README
Jadd : 另一个文档导出工具
为什么？
- 因为我们热爱阅读REST API的文档。
- 我们真的不喜欢编写文档。
- 我们真的不喜欢更新文档。
- 注释是邪恶的
如何？
需要两个步骤
在功能测试期间收集响应
当然你有你API的测试。那么为什么不让它连接到它并记录你测试的所有用例呢？
如果你使用php-http，我们提供了一个中间件在测试期间收集数据。查看测试以确定如何使用它。
合并路由文件
然后只需要运行bin/jadd generate <myRoutingFile> <outputFile>
它将解析你的路由并将记录的响应与测试合并。
最佳位置是在CI的onSuccess钩子中。
安装
目前，我们只支持通过composer在PHP项目中安装。
composer require --dev rezzza/jadd:dev-master
支持的路由
- Symfony YAML（不支持控制器中的YAML +
@Route注释）