sowl / laravel-doctrine-jsonapi
这是一个用于Laravel的包,允许开发者使用Doctrine ORM创建用于数据持久化的JSON:API端点。
10.0.3
2024-07-31 14:51 UTC
Requires
- php: ^8.1
- doctrine/orm: ^2.14
- laravel/framework: ^10.0
- league/fractal: ^0.20.1
- ramsey/uuid: ^4.7
Requires (Dev)
- doctrine/annotations: ^2
- fzaninotto/faker: ^1.5
- gedmo/doctrine-extensions: ^3.11
- laravel-doctrine/acl: ^1.7
- laravel-doctrine/extensions: ^1.6
- laravel-doctrine/migrations: ^3.1
- laravel-doctrine/orm: ^2.0
- mockery/mockery: ^1.5
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-10-01 00:09:08 UTC
README
在您的 Laravel 应用程序中使用 Doctrine ORM 实现 JSON:API 兼容的丰富功能API。
功能
- 专为Doctrine ORM构建
- 经过实战考验
- 标准化、一致的API
- 获取资源
- 获取关系
- 包含相关资源(复合文档)
- 稀疏字段集
- 排序
- 分页
- 过滤
- 创建资源
- 更新资源
- 更新关系
- 删除资源
文档
安装说明、配置指南和教程。
开发
在本地克隆项目。
安装包依赖并运行测试
docker compose run php
进入docker容器
docker compose run php sh
测试
路线图
- 使禁用链接生成成为可能。因为JSON:API规范不需要它,并且会增加响应大小。
- 创建一个用于验证资源标识符的验证规则 "resource","resourceExists"。用法示例:
php $this->validate($request, ['data' => 'required|resource:users']); - 创建默认的全局错误处理器或编写如何创建此类处理器的文档。如何处理404找不到路由/端点和500内部错误。
- 创建用于资源策略生成的控制台命令:"jsonapi:make:policy"。
- 检查添加如 "include=roles:sort"(TransformerAbstract.php:173)这样的include参数的选项。