premiervirtual/laravel-json-api

Laravel应用程序的JSON API (jsonapi.org) 支持。

v6.0.0 2023-02-14 20:13 UTC

README

Tests

cloudcreativity/laravel-json-api

状态

此包已被重写,大幅改进并作为 laravel-json-api/laravel 包发布。 新版本的文档可在我们的新网站 laraveljsonapi.io 上找到,代码现在在 Laravel JSON:API Github 组织 下开发。

cloudcreativity/laravel-json-api 包现在被视为 遗留 包。鉴于它在许多生产应用中被使用,它将继续接收针对新Laravel版本的错误修复和更新。但是,它不再支持新功能。

如果您正在启动一个新的项目,请使用 新包 laravel-json-api/laravel

简介

在Laravel中构建功能丰富且符合标准的API。

此包提供了您添加符合 JSON API 标准的API所需的所有功能。对规范的全面支持,包括

  • 获取资源
  • 获取关系
  • 包含相关资源(复合文档)
  • 稀疏字段集。
  • 排序。
  • 分页。
  • 过滤。
  • 创建资源。
  • 更新资源。
  • 更新关系。
  • 删除资源。
  • 验证
    • JSON API文档;以及
    • 查询参数。

以下附加功能也得到支持

  • 对Eloquent资源的完全支持,具有以下功能
    • 包含相关资源时自动预加载。
    • 轻松的关系端点。
    • 软删除和恢复Eloquent资源。
    • 基于页面和光标分页。
  • 异步处理。
  • 支持API内的多个媒体类型。
  • 为将资源添加到API所需的所有类提供生成器。

什么是JSON API?

来自 jsonapi.org

如果您曾经与您的团队就JSON响应的格式进行过争论,JSON API就是您的防自行车道工具。

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

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

教程和文档

想要一个入门教程吗?阅读 如何JSON:API Laravel教程。

完整的包文档可在 Read the Docs 上找到。

Slack

加入Laravel JSON:API社区 Slack。

Laravel版本

在升级到主要版本或预发布版本时,请确保查阅 升级指南

许可

Apache许可证(版本2.0)。有关更多信息,请参阅 许可文件

安装

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

贡献

欢迎贡献力量。理想情况下,提交一个拉取请求,甚至更理想的是带有单元测试的拉取请求。请注意以下事项:

  • 错误修复 - 向 master 分支提交拉取请求。
  • 增强/新功能 - 向 develop 分支提交拉取请求。

建议在准备拉取请求之前先提交一个问题。