README

JSON Api ❤️ Doctrine ORM

JAD 是一个用于快速开发 JSON API 后端 REST 实现的库。您可以使用 php -S 运行 JAD 作为独立服务器（见演示），或者将其用作框架中的中间件。

它将 doctrine 实体自动转换为 JSON API 资源，或资源集合。

需求

您需要安装 Doctrine，并最好在开始使用 Jad 之前进行设置。

安装

composer require oligus/jad

快速入门

对您想公开到 JSON-API 的实体进行注解

/**
 * @ORM\Entity
 * @ORM\Table(name="albums")
 * @Jad\Map\Annotations\Header(type="albums")
 */
class Albums
{
...

使用当前实体管理器设置 JAD

$jad = new Jad(new Jad\Map\AnnotationMapper($em));
$jad->setPathPrefix('/api/v1/jad');
$jad->jsonApiResult();

获取结果

GET /api/v1/jad/albums

内容

支持

Lumen

通过中间件支持 Lumen。

在您的 Lumen 启动文件（../lumen/bootstrap/app.php）中

// Jad middleware
$app->middleware([
    'jad' => Jad\Support\Lumen\JadMiddleWare::class,
]);

...

// Register Service Providers
$app->register(Jad\Support\Lumen\JadServiceProvider::class);

您可以使用默认配置，或者将 lumen/vendor/oligus/jad/src/Support/Lumen/jad.php 复制到 /lumen/config 并在那里进行更改。

贡献

在向此存储库贡献之前，请先通过问题讨论您想进行的更改，然后再发起拉取请求。

作者

Oli Gustafsson - 初始工作 - oligus

许可

本项目采用 MIT 许可证 - 详细信息请参阅 LICENSE 文件

oligus / jad

维护者

详情

README

需求

安装

快速入门

内容

支持

Lumen

贡献

作者

许可