README

标题

这是neomerx/json-api的维护分支。

描述

一个好的API是提高客户体验最有效的方式之一。标准化的数据格式和通信协议可以增加生产力和简化应用程序之间的集成。

这个框架无关的包实现了JSON API规范版本 v1.1，并有助于集中精力在核心应用程序功能上，而不是协议实现上。它支持文档结构、错误、数据获取，如JSON API 格式中所述，并涵盖了解析和检查HTTP请求参数和头部。例如，它有助于对无效请求正确响应 Unsupported Media Type（HTTP状态码 415）和 Not Acceptable（HTTP状态码 406）。您不需要在每次请求上手动验证所有输入参数。您可以配置服务支持哪些参数，并且这个包将自动检查传入的请求。它极大地简化了API开发，并完全支持规范。特别是

资源属性和关系
多态资源数据和关系
包含相关资源的复合文档（支持循环资源引用）
文档、资源、错误、关系和链接对象的元信息
配置文件
根据RFC 7231解析HTTP Accept 和 Content-Type 头部
解析HTTP查询参数（例如分页、排序等）
稀疏字段集和自定义包含路径
错误

高代码质量和 100% 测试覆盖率，带有 150+ 测试。适用于生产环境。

要了解更多信息，请查看Wiki和示例应用程序.

“我喜欢它如何让快速实现API变得如此简单”
– Jeremy Cloutier

全栈集成

这个包是框架无关的，如果您正在寻找实际用例示例，您可能会对快速启动JSON API服务器应用程序Limoncello App感兴趣。

服务器支持

几个示例数据模型和用户的CRUD操作。
到API服务器的跨域请求（CORS）。
身份验证（Bearer令牌）和CRUD操作的授权。
支持诸如资源包含、分页等JSON API功能。

示例用法

假设您有一个类型为 \Author 的 $author，您可以像这样将其编码为JSON API

$encoder = Encoder::instance([
        Author::class => AuthorSchema::class,
    ])
    ->withUrlPrefix('http://example.com/api/v1')
    ->withEncodeOptions(JSON_PRETTY_PRINT);

echo $encoder->encodeData($author) . PHP_EOL;

将输出

{
    "data" : {
        "type"       : "people",
        "id"         : "123",
        "attributes" : {
            "first-name": "John",
            "last-name": "Doe"
        },
        "relationships" : {
            "comments" : {
                "links": {
                    "related" : "http://example.com/api/v1/people/123/comments"
                }
            }
        },
        "links" : {
            "self" : "http://example.com/api/v1/people/123"
        }
    }
}

AuthorSchema提供了关于资源属性的信息，可能看起来像这样

class AuthorSchema extends BaseSchema
{
    public function getType(): string
    {
        return 'people';
    }

    public function getId($author): ?string
    {
        return $author->authorId;
    }

    public function getAttributes($author, ContextInterface $context): iterable
    {
        return [
            'first-name' => $author->firstName,
            'last-name'  => $author->lastName,
        ];
    }

    public function getRelationships($author, ContextInterface $context): iterable
    {
        return [
            'comments' => [
                self::RELATIONSHIP_LINKS_SELF    => false,
                self::RELATIONSHIP_LINKS_RELATED => true,

                // Data include supported as well as other cool features
                // self::RELATIONSHIP_DATA => $author->comments,
            ],
        ];
    }
}

参数 http://example.com/api/v1 是将应用于所有编码链接的URL前缀，除非它们有标志设置为不添加任何前缀。

参数 JSON_PRETTY_PRINT 是PHP预定义的JSON常量。

一个包含多个、嵌套、过滤对象以及更多内容的示例程序在此处。

要了解更多高级用法，请查看Wiki.

版本

当前版本为4.x（PHP 7.1+），对于较旧的PHP（PHP 5.5 - 7.0，HHVM）请使用版本1.x。

有问题吗？

请随时查看问题或发布一个新的问题。

需要帮助吗？

您计划添加JSON API并需要帮助吗？我们很乐意与您sales@neomerx.com联系。

贡献

如果您发现了任何未反映在此包中的规范变更，请发布一个问题。欢迎提交文档和代码改进的pull request。

发送pull request有两种方式

小型的pull request应该作为1个提交发送到develop分支。
对于较大的pull request（例如新功能），建议创建一个问题请求为该功能创建一个新的分支。当创建了一个名为feature/issueXX的新分支（其中XX是问题号）时，您应该向这个分支提交pull request。当功能完成时，该分支将被压缩并合并到develop分支，然后合并到master分支。

许可证

Apache许可证（版本2.0）。有关更多信息，请参阅许可证文件。

geodpto / json-api

维护者

详细信息

README

标题

描述

全栈集成

示例用法

版本

有问题吗？

需要帮助吗？

贡献

许可证