README

为您的 OpenAPI 请求、响应和架构生成虚假数据的库。

$faker = \Vural\OpenAPIFaker\OpenAPIFaker::createFromJson($yourSchemaAsJson);
$fakeData = $faker->mockResponse('/todos','GET');

安装

您可以通过 composer 安装此包

composer require --dev canvural/php-openapi-faker

使用方法

首先，您需要创建一个 OpenAPIFaker 实例，该实例包含您要从其生成虚假数据的架构。您可以使用 createFromJson、createFromYaml 或 createFromSchema 创建 OpenAPIFaker 的实例。

$faker = \Vural\OpenAPIFaker\OpenAPIFaker::createFromJson($yourSchemaAsJson);

然后，您可以在其实例上使用 mockResponse、mockResponseForExample、mockRequest、mockRequestForExample、mockComponentSchema 和 mockComponentSchemaForExample 方法来生成您的请求、响应和架构的虚假数据。例如

$fakeData = $faker->mockResponse('/todos','GET');

选项

有一些选项可以用来修改一些行为。您可以将选项作为关联数组传递给 OpenAPIFaker 中的 setOptions 方法。例如

$faker = \Vural\OpenAPIFaker\OpenAPIFaker::createFromJson($yourSchemaAsJson)
    ->setOptions(['minItems' => 5]);

以下是对每个选项的解释。

`minItems`

如果此值小于 minItems 属性，则覆盖 minItems 属性。

`maxItems`

如果此值大于 maxItems，则覆盖 maxItems。

`alwaysFakeOptionals`

如果启用，则无论属性或项是否必需，都将生成每个属性或项。默认值：false

`strategy`

默认情况下，OpenAPIFaker 使用动态生成策略。您可以使用 static 策略启用静态示例生成。默认值：dynamic

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

致谢

人物

资源

许可

MIT 许可证（MIT）。请参阅许可文件了解更多信息。

canvural / php-openapi-faker

维护者

详细信息