dorgaren/laravel-json-api

Laravel应用程序的旧版(0.x)JSON API(jsonapi.org)支持

v0.14.1 2019-10-06 16:51 UTC

This package is not auto-updated.

Last update: 2024-10-01 14:07:52 UTC


README

此软件包是从cloudcreativity/laravel-json-api派生的。它是为了保持与0.x版本的向下兼容性而创建的。

原因

  • 没有从0.x到1.x的升级指南或变更日志;
  • 架构已经发生根本性变化,甚至到了类成为final的地步;
  • 没有明确的(或含糊不清的)理由支持架构决策;
  • 0.13是最后一个0.x版本;
  • 并且0.13与Laravel 5.8+不兼容。

由于我目前必须维护至少一个在最后一个版本是0.12.0时创建的项目,扩展已经变为final的类,以及该软件包的架构对可能的用例提出严重质疑,我认为重新构建原始分支比升级任何项目要容易。

如果您面临类似问题,请随意使用此分支。我在附近的时候,可以保证我会提高版本,甚至进行必要的微小修改以保持与新的Laravel版本兼容,并且在我认为任何进一步的不切实际或不合适的事情时,我会做出回应。

尽管如此,对于任何新的“绿色田野”项目,建议您使用主线软件包,无论是1.x还是当它最终确定时的2.0。

将符合jsonapi.org规范的API添加到您的Laravel 5应用程序中。基于框架无关的软件包neomerx/json-apicloudcreativity/json-api

什么是JSON API?

来自jsonapi.org

如果您曾经与您的团队就JSON响应的格式进行过争论,JSON API就是您的反“自行车的车把”武器。

通过遵循共享约定,您可以提高生产力,利用通用工具,并专注于最重要的事情:您的应用程序。围绕JSON API构建的客户端能够利用其高效缓存响应的功能,有时甚至可以完全消除网络请求。

有关规范的全部信息,包括示例,请参阅https://jsonapi.fullstack.org.cn

演示

演示应用程序可在此处找到。

Laravel版本

在升级时,请务必查阅升级指南

Lumen

目前我们尚未将软件包与Lumen集成。如果您使用Lumen并且可以帮助我们,请在此问题上告知我们。

文档

文档可在Read the Docs上找到。

状态

此存储库处于开发中。我们有一些正在使用该软件包的生产应用程序,并对这些应用程序进行了广泛的测试。

我们力争尽快推出v1.0版本。请查看此问题了解进展。

许可证

Apache许可证(版本2.0)。请参阅许可证文件获取更多信息。

安装

安装通过composer完成。请参阅文档以获取完整说明。

贡献

我们非常欢迎贡献。理想情况下,请提交一个pull request,更理想的是附带单元测试。请注意以下事项:

  • 错误修复 - 向master分支提交pull request。
  • 增强/新功能 - 向develop分支提交pull request。

我们建议在准备pull request之前先提交一个issue。