vgirol/jsonapi-faker

此包已被废弃且不再维护。未建议替代包。

此包提供了一个使用JSON:API规范生成假数据的工厂。

v1.3.0 2021-04-04 22:01 UTC

This package is auto-updated.

Last update: 2022-02-04 23:51:25 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Infection MSI Total Downloads

此包提供了一组工厂,用于根据JSON:API规范构建假数据。

技术

  • PHP 7.3+

安装

要使用composer安装,只需将以下内容放入您的composer.json文件中

{
    "require-dev": {
        "vgirol/jsonapi-faker": "dev-master"
    }
}

然后从终端运行composer install

快速安装

上述安装也可以通过以下命令简化

composer require vgirol/jsonapi-faker

用法

首先创建一个faker生成器。

use VGirol\JsonApiFaker\Generator as JsonApiFaker;

$faker = new JsonApiFaker;

然后创建一个工厂。

$factory = $faker->resourceObject();

接下来你可以填充工厂...

$factory->setResourceType('test')
        ->setId('1')
        ->setAttributes([
            'attr1' => 'value1',
            'attr2' => 'value2'
        ])
        ->setMeta([
            'key1' => 'meta1'
        ])
        ->addLink('self', 'url');

...或者生成一个假数据。

$factory->fake();

最后导出为数组或JSON格式。

$array = $factory->toArray();
$json = $factory->toJson();

所有这些指令都可以链式调用。

use VGirol\JsonApiFaker\Generator as JsonApiFaker;

$json = new JsonApiFaker()
    ->resourceObject()
    ->fake()
    ->toJson();

文档

API文档以XHTML格式提供,网址为http://jsonapi-faker.girol.fr/docs/ref/index.html

变更日志

有关最近变更的更多信息,请参阅CHANGELOG

测试

composer test

贡献

请参阅CONTRIBUTINGCODE_OF_CONDUCT以获取详细信息。

安全

如果您发现任何安全相关的问题,请通过电子邮件vincent@girol.fr联系,而不是使用问题跟踪器。

鸣谢

许可

MIT许可(MIT)。请参阅许可文件以获取更多信息。