cloudcreativity / laravel-json-api
Laravel应用程序的JSON API (jsonapi.org) 支持。
Requires
- php: ^8.2
- ext-json: *
- laravel-json-api/neomerx-json-api: ^5.0.2
- laravel/framework: ^11.0
- nyholm/psr7: ^1.8
- ramsey/uuid: ^4.0
- symfony/psr-http-message-bridge: ^7.0
Requires (Dev)
- ext-sqlite3: *
- guzzlehttp/guzzle: ^7.8
- laravel-json-api/testing: ^3.0
- laravel/legacy-factories: ^1.4.0
- laravel/ui: ^4.4
- mockery/mockery: ^1.6
- orchestra/testbench: ^9.0
- phpunit/phpunit: ^10.5
Suggests
- cloudcreativity/json-api-testing: Required to use the test helpers.
- dev-develop / 7.x-dev
- v7.0.0
- v6.1.0
- v6.0.0
- v5.0.0
- v5.0.0-alpha.1
- v4.1.0
- v4.0.1
- v4.0.0
- v3.3.0
- v3.2.0
- v3.1.0
- v3.0.1
- v3.0.0
- 2.x-dev
- v2.2.0
- v2.1.0
- v2.0.0
- v2.0.0-beta.3
- v2.0.0-beta.2
- v2.0.0-beta.1
- v2.0.0-alpha.2
- v2.0.0-alpha.1
- 1.x-dev
- v1.7.0
- v1.6.0
- v1.5.0
- v1.4.0
- v1.3.1
- v1.3.0
- v1.2.0
- v1.1.0
- v1.0.1
- v1.0.0
- v1.0.0-rc.2
- v1.0.0-rc.1
- v1.0.0-beta.6
- v1.0.0-beta.5
- v1.0.0-beta.4
- v1.0.0-beta.3
- v1.0.0-beta.2
- v1.0.0-beta.1
- v1.0.0-alpha.4
- v1.0.0-alpha.3
- v1.0.0-alpha.2
- v1.0.0-alpha.1
- 0.x-dev
- v0.13.0
- v0.12.0
- v0.11.5
- v0.11.4
- v0.11.3
- v0.11.2
- v0.11.1
- v0.11.0
- v0.10.3
- v0.10.2
- v0.10.1
- v0.10.0
- v0.9.1
- v0.9.0
- v0.8.0
- v0.7.0
- v0.6.2
- v0.6.1
- v0.6.0
- v0.5.4
- v0.5.3
- v0.5.2
- v0.5.1
- v0.5.0
- v0.4.6
- v0.4.5
- v0.4.4
- v0.4.3
- v0.4.2
- v0.4.1
- v0.4.0
- v0.3.0
- v0.2.1
- v0.2.0
- v0.1.1
- v0.1.0
- dev-main
- dev-testing
- dev-async-with-cn
- dev-feature/pagination
This package is auto-updated.
Last update: 2024-09-14 19:19:56 UTC
README
cloudcreativity/laravel-json-api
状态
请不要为此新项目使用此包 - 使用laravel-json-api/laravel代替。
此包已重写,大幅改进,并作为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?
如果您曾因JSON响应的格式与团队争论,JSON API就是您的防自行车棚武器。
通过遵循共享约定,您可以提高生产力,利用通用工具,并专注于重要的事情:您的应用程序。围绕JSON API构建的客户端能够利用其高效的响应缓存功能,有时甚至可以完全消除网络请求。
有关规范的全部信息,包括示例,请参阅http://jsonapi.org。
文档
完整的包文档可在Read the Docs上找到。
Slack
加入Laravel JSON:API社区Slack。
Laravel版本
在升级到主版本或预发布版本之间时,请务必咨询升级指南。
许可证
Apache许可证(版本2.0)。请参阅许可证文件以获取更多信息。
安装
安装通过composer
进行。请参阅文档以获取完整说明。
贡献
欢迎贡献。理想情况下,提交一个拉取请求,更理想的是附带单元测试。请注意以下事项
- 错误修复 - 向
master
分支提交拉取请求。 - 增强/新功能 - 向
develop
分支提交拉取请求。
我们建议在提交拉取请求之前先提交一个问题。