plehatron / limoncello-bundle

neomerx/json-api 的 Symfony 集成包

安装: 5

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 0

开放问题: 0

类型:symfony-bundle

dev-master 2016-04-07 20:59 UTC

This package is not auto-updated.

Last update: 2024-09-20 19:24:57 UTC


README

LimoncelloBundle 是 neomerx/json-api 和 Symfony 的集成包。

Build Status codecov.io

安装

  1. 使用 composer 下载 LimoncelloBundle
$ composer require plehatron/limoncello-bundle "dev-master@dev"
  1. 启用该包
<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Plehatron\LimoncelloBundle\PlehatronLimoncelloBundle(),
        // ...
    );
}

创建并注册 JSON API 模式类

请参阅 CategorySchema 文件,从集成测试中了解如何编写 JSON API 模式类。

注册模式类和相应实体类的映射

# app/config.yml
# ...

plehatron_limoncello:
    schemas:
        ApiBundle\Entity\Category: ApiBundle\Schema\CategorySchema

创建并注册 JSON API 控制器

API 控制器应扩展抽象类 \Plehatron\LimoncelloBundle\Controller\JsonApiController,该类由 neomerx/limoncello 包提供完整的 JSON API 支持。

请参阅 CategoryController 文件,了解如何编写 JSON API 控制器。

版本管理

此包遵循 语义版本控制 方案。

测试

使用以下命令运行测试

$ vendor/bin/phpunit

鸣谢

此包基于 elytus-limoncello-bundle

许可证

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