skqr/hateoas-bundle

GOintegro HATEOAS Bundle

安装: 26

依赖者: 0

建议者: 0

安全: 0

星标: 3

关注者: 3

分支: 10

开放问题: 0

类型:symfony-bundle

v0.10.10 2016-12-16 15:10 UTC

README

Build Status Code Climate

这是一个为 GOintegro HATEOAS 库 而设计的 Symfony 2 扩展包,使用 Doctrine 2 实体映射和 RAML API 定义来生成遵循 JSON-API 规范的 HATEOAS API。

您不会得到脚手架,您会得到一个可工作的 API。

您将获得一个功能比 一只美洲狮的自我感觉 更好的可工作的 API。

试试看

查看 示例应用程序项目,这样您可以在不费太多周折的情况下亲身体验到魔法。

安装

步骤 1:下载 Bundle

打开命令行,进入您的项目目录,并执行以下命令以下载此 bundle 的最新稳定版本

$ composer require skqr/hateoas-bundle

此命令需要您全局安装了 Composer,如 Composer 文档的 安装章节 所述。

步骤 2:启用 Bundle

然后,通过在您的项目的 app/AppKernel.php 文件中添加以下行来启用该 bundle

<?php
// app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            new GoIntegro\Bundle\HateoasBundle\GoIntegroHateoasBundle(),
        );
    }
}
?>

步骤 3:添加以下参数

# app/config/parameters.yml

# HATEOAS API
api.base_url: "http://api.gointegro.com"
api.url_path: "/api/v2"
api.resource_class_path: "Rest2/Resource"

步骤 4:添加以下路由

# app/config/routing.yml

# Place it underneath it all - it contains a catch-all route.
go_integro_hateoas:
    resource: "@GoIntegroHateoasBundle/Resources/config/routing.yml"
    prefix: /api/v2

用法

查看 库文档 获取更多信息。