README

提供对symfony中jsonapi的支持的包，以尽可能原生的方式提供。

开发中

此包目前正在积极开发中，但被认为适用于生产。

如何安装

设置包的指南位于快速入门指南

示例用法

要快速开始，请参阅快速入门指南。您还可以查看位于测试套件中的示例代码。

高级用法

有关快速入门中未涵盖的高级用法，请参阅高级用法

要求

此包使用symfony 3和doctrine。

文档和示例

示例代码也可以在tests/Resources/中找到。

文档位于src/Resources/doc/目录中。

问题

使用问题跟踪器。

已知限制

每个启用jsonapi的动作都必须以Request作为第一个参数接收参数

版本控制和变更日志

项目遵循语义版本控制。

项目的变更日志可以在changelog.md中找到。

测试

整个沙箱和开发环境都位于项目中。

要运行测试，请定位到tests/Resources/docker并运行bin/test.sh。这将构建整个docker设置，加载测试数据和运行所有测试套件。

贡献

待办编写人们如何发送pull请求的说明

对于包的开发，我们使用与测试相同的工具。定位到tests/Resources/docker并运行bin/start.sh。PHP CLI命令可以在同一目录中通过bin/console运行。还有一个php访问脚本bin/php [CMD]（例如bin/php bash进入bash）。

编码规范

在为这个包做出贡献时，您需要遵守我们的编码规范。它们遵循PSR-2，并有一些额外的规则。在开发过程中检查您的代码，您可以使用提供的php-cs-fixer配置。它位于项目的根目录中，文件名为

.php_cs.dist

检查您的代码

首先，您需要设置测试环境（如上所述）。

然后

检查代码

bin/php_cs --dry-run

如果您想自动修复，请省略`--dry-run`

bin/php_cs

这将检查并修复您的代码。

鸣谢

版权（C）2017 Trikoder

作者：Alen Pokos。

贡献者（按字母顺序排列）：Antonio Pauletich，Alen Pokos，Antonio Šunjić，Damir Trputec，Juraj Juričić，Krešo Kunjas，Petar Obradović，Vedran Krizek，Vedran Mihočinec

许可

此包根据MIT许可许可。

trikoder / jsonapibundle

维护者

详情