vgirol/jsonapi-structure

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

检查 JSON:API 请求内容的工具

v1.3.2 2021-04-04 21:47 UTC

This package is auto-updated.

Last update: 2022-02-04 23:36:01 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-structure": "dev-master"
    }
}

然后从终端运行 composer install

快速安装

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

$ composer require vgirol/jsonapi-structure

使用

use VGirol\JsonApiStructure\ValidateService;

$json = [
    'data' => [
        'type' => 'resource',
        'id' => '5'
    ],
    'jsonapi' => [
        'version' => '1.0',
        'meta' => [
            'key' => 'value'
        ]
    ]
];

$service = new ValidateService('POST');
$service->validateStructure($json);

文档

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

变更日志

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

测试

composer test

贡献

有关详细信息,请参阅 CONTRIBUTINGCODE_OF_CONDUCT

安全

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

鸣谢

许可

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