floor9design/json-api-formatter

一组允许创建符合JSON API规范的类的集合

维护者

详细信息

github.com/floor9design-ltd/json-api-formatter

主页

源代码

问题

安装: 20,901

依赖项: 1

建议者: 0

安全: 0

星标: 10

关注者: 3

分支: 1

公开问题: 0

1.3.1 2023-02-25 19:09 UTC

Requires

Requires (Dev)

MIT 1b9ec86cef811f2894116a059a631edb95fea703

restapijsonapifloor9design

This package is auto-updated.

Last update: 2024-09-28 02:09:47 UTC

README

Latest Version Packagist Software License

Build Status Build Status

Github Downloads Packagist Downloads

一组允许创建符合JSON API规范的类的集合

简介

JSON API具有精确的响应格式。这一组类允许轻松创建和查询这些格式，意味着输出/输入处理既简单又可靠。

输出非常简单

use Floor9design\JsonApiFormatter\Models\JsonApiFormatter;

// Some example data:
$id = "2"; 
$type = 'test';
$attributes = ['test' => 'data'];

$json_api_response = new JsonApiFormatter();

$response = $json_api_response->dataResourceResponse($id, $type, $attributes); 
// a json-api string, good for direct output

其他响应和元素，如错误、元数据、链接和源元素都受支持。

更多示例，请参阅使用说明。

功能

Latest Version Packagist

这些类提供

  • 简单的方法来封装和解封装内容
  • 开箱即用的默认值和设置，提高响应质量
  • 流畅的编程方法，允许动态构建对象

安装

通过Composer/packagist

Packagist Downloads

composer require floor9design/json-api-formatter

通过git

Github Downloads

git clone https://github.com/floor9design-ltd/json-api-formatter.git

或者

git clone git@github.com:floor9design-ltd/json-api-formatter.git

使用

这将在使用说明中讨论。

设置

不需要特定的配置设置步骤。在PSR-4兼容的系统中，类应该自动加载。如果您单独使用该类，请以最合适的方式包含它。

测试

Build Status Build Status

测试可以按照以下方式运行

  • ./vendor/phpunit/phpunit/phpunit

可以使用phpstan执行静态分析和代码审查

  • ./vendor/bin/phpstan

以下测试还会创建代码覆盖率（通常保持在100%）

  • ./vendor/phpunit/phpunit/phpunit --coverage-html docs/tests/

注意，以下内容对于验证/测试输出非常有用

致谢

变更日志

变更日志在这里生成

许可证

本软件可在MIT许可证下获得。