mdc / swagger-test
一套基于Swagger或OpenAPI文档使用PHPUnit测试REST调用的工具
2.0.1
2024-08-27 06:42 UTC
Requires
- php: >=8.1
- ext-json: *
- byjg/webrequest: 4.9.*
Requires (Dev)
- byjg/restserver: 4.9.*
- phpunit/phpunit: 5.7.*|7.4.*|^9.5|^10.5
README
一套基于OpenApi规范使用PHPUnit测试你的REST调用的工具。当前,这个库支持OpenApi规范2.0(以前称为swagger)和3.0。一些功能,如回调、链接和对外部文档/对象的引用尚未实现。
PHP Swagger Test可以帮助您测试REST API。您可以使用此工具进行单元测试或功能测试。
此工具读取先前的Swagger JSON文件(非YAML)并允许您测试请求和响应。当您开发REST API时,您可以使用https://github.com/zircote/swagger-php工具来创建JSON文件。
ApiTestCase的断言过程基于抛出异常,如果某些验证或测试失败。
PHP Swagger测试的使用案例
您可以使用Swagger测试库作为
谁在使用这个库?
安装
composer require "byjg/swagger-test"
测试
SPEC=swagger php -S 127.0.0.1:8080 tests/rest/app.php & SPEC=openapi php -S 127.0.0.1:8081 tests/rest/app.php & vendor/bin/phpunit
有问题?
请在Github issue上提出您的问题。
参考文献
此项目使用byjg/webrequest组件。它实现了PSR-7规范,并有一个HttpClient / MockClient来执行请求。查看它以获取更多信息。