mlambley/swagvalidator

验证数据是否符合Swagger模式

维护者

详细信息

github.com/mlambley/swagvalidator

源代码

问题

安装: 65

依赖项: 0

建议者: 0

安全性: 0

星星: 0

关注者: 2

分支: 0

公开问题: 0

1.0.0 2020-11-25 01:51 UTC

Requires

  • php: >=5.6

Requires (Dev)

MIT 10de230bc548a7d3e12b04133650867a708c7d51

  • Mark Lambley <mlambley.woop@gmail.com>

This package is auto-updated.

Last update: 2024-08-29 05:30:41 UTC

README

验证数据是否符合Swagger模式

如何安装

composer require --dev mlambley/swagvalidator

什么是Swagger？

Swagger 2.0（也称为Open API 2.0）定义了您的API结构，包括端点和输入输出数据的结构。有关更多信息，请参阅他们的网站。

什么是Swagvalidator？

如果您有一个现有的Swagger 2.0规范，您可以使用它通过此工具验证API的输入或输出数据。此库完全考虑了Swagger 2.0规范的功能。

要求

无。这是一个纯PHP工具，无依赖项，与PHP 5.6及更高版本兼容。

用法

use Mlambley\Swagvalidator\Validator\Validator;
use Mlambley\Swagvalidator\Exception\ValidationException;

$response = $this->getApi("your/path");
$json = (string)$response->getBody();
$data = json_decode($json);
$schema = json_decode(file_get_contents(__DIR__ . '/swagger.json'));

try {
    (new Validator())
        ->validate($schema->paths->{"your/path"}->get->responses->{"200"}->schema, $data);
} catch (ValidationException $e) {
    //dd($e->getMessage());
}

有问题？

在github issue中记录问题。感谢您的帮助。