byjg/swagger-test

基于Swagger或OpenAPI文档,使用PHPUnit测试REST调用的工具集

资助包维护!
byjg

4.9.2 2024-06-04 22:54 UTC

This package is auto-updated.

Last update: 2024-09-16 15:24:28 UTC


README

Build Status Opensource ByJG GitHub source GitHub license GitHub release Scrutinizer Code Quality

一套基于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 test的使用案例

您可以将Swagger Test库用作

谁在使用这个库?

安装

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进行请求。查看它以获取更多信息。

依赖

开源ByJG