mlambley/swagfaker

从 Swagger 架构创建伪造数据

维护者

详细信息

github.com/mlambley/swagfaker

源代码

问题

安装数量: 6,393

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 0

开放问题: 4

1.0.1 2020-11-02 06:48 UTC

Requires

Requires (Dev)

MIT 7448ddeb68c90181498eb40a0487f671604cde27

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

This package is auto-updated.

Last update: 2024-09-21 22:08:05 UTC

README

生成伪造数据，这些数据将验证您的 Swagger 2.0 架构。

如何安装

composer require mlambley/swagfaker:^1.0

什么是 Swagger？

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

什么是 Swagfaker？

Swagfaker 允许您根据现有的 Swagger 2.0 规范生成伪造数据。您可以使用它来生成在验收测试期间发送到您的 API 的数据。

示例

假设您的 Swagger 架构如下所示

{
  "type": "object",
  "required": [
    "Name",
    "DateOfBirth",
    "Identifier",
    "VisitCount"
  ],
  "properties": {
    "Name": {
      "type": "string"
    },
    "DateOfBirth": {
      "type": "string",
      "format": "date"
    },
    "Identifier": {
      "type": "string",
      "pattern": "^[0-9]{3}-[0-9]{4}$"
    },
    "VisitCount": {
      "type": "integer",
      "minimum": 0
    }
  }
}

然后使用以下方式生成伪造数据

$values = (new \SwaggerFaker\Faker())->generate($schema);

您的值现在可能看起来像这样

object(stdClass) {
  "Name" => "Quod."
  "DateOfBirth" => "1971-08-20"
  "Identifier" => "037-1259"
  "VisitCount" => 1463093889
}

问题？

在github issue 中记录问题。您的帮助将受到赞赏。

致谢

感谢 Leko 他们的 JSON Schema Faker，本库最初是从该库复制而来的。