vgirol/jsonapi-assert

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

此包提供了一组断言，用于测试符合 JSON:API 规范的文档。

维护者

详细信息

github.com/VGirol/JsonApi-Assert

主页

源代码

问题

安装: 703

依赖: 3

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

v2.2.2 2021-04-04 21:54 UTC

Requires

Requires (Dev)

MIT d15281ca9b66a1a6d52a52dc62632585aab54ba0

  • Vincent Girol <vincent.woop@girol.fr>

unit testsassertionsjson apivgiroljsonapi-assert

This package is auto-updated.

Last update: 2022-02-05 00:09:30 UTC

README

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

此包提供了一组断言，用于测试符合 JSON:API 规范 的文档。

技术

  • PHP 7.3+
  • PHPUnit 9.0+

安装

要通过 composer 安装，只需在您的 composer.json 文件中添加以下内容

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

然后从终端运行 composer install。

快速安装

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

composer require vgirol/jsonapi-assert

使用

您可以直接在类中使用这些断言作为静态调用。

use VGirol\JsonApiAssert\Assert as JsonApiAssert;

class MyTest extends TestCase
{
    /**
     * @test
     */
    public function my_first_test()
    {
        $json = [
            'meta' => [
                'key' => 'value'
            ],
            'jsonapi' => [
                'version' => '1.0'
            ]
        ];

        JsonApiAssert::assertHasValidStructure($json);
    }
}
use VGirol\JsonApiAssert\Assert as JsonApiAssert;
use VGirol\JsonApiAssert\SetExceptionsTrait;
use VGirol\JsonApiStructure\Messages;

class MyTest extends TestCase
{
    use SetExceptionsTrait;

    /**
     * @test
     */
    public function how_to_assert_that_a_test_failed()
    {
        $json = [
            'errors' => [
                'error' => 'not an array of error objects'
            ]
        ];
        $failureMessage = Messages::ERRORS_OBJECT_MUST_BE_ARRAY;

        $this->setAssertionFailure($failureMessage);

        JsonApiAssert::assertHasValidStructure($json);
    }
}

文档

API 文档以 XHTML 格式可在以下 URL 获取：http://jsonapi-assert.girol.fr/docs/ref/index.html。

变更日志

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

测试

composer test

贡献

请参阅 CONTRIBUTING 和 CODE_OF_CONDUCT 了解详细信息。

安全

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

鸣谢

许可

MIT 许可证 (MIT)。有关更多信息，请参阅 许可文件。