README

此包提供REST API的基础功能

安装

composer

composer require maesbox/apibundle ~1.1

kernel

将这些行添加到 app/AppKernel.php

<?php

use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\Config\Loader\LoaderInterface;

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
		...
			new FOS\RestBundle\FOSRestBundle(),
			new Nelmio\CorsBundle\NelmioCorsBundle(),
			new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
			new Maesbox\CommonBundle\MaesboxCommonBundle(),
			new Maesbox\ApiBundle\MaesboxApiBundle(),

		...
		);
	}
	...
}

routing

将这些行添加到 app/routing.yml

MaesboxApiBundle:
	resource: "@MaesboxApiBundle/Resources/config/routing.yml"
	prefix:   /api

注意：默认添加了 nelmio/api-doc-bundle 的路由

特性

controller

该包提供REST控制器的基础类，请参考friendofsymfony/rest-bundle 文档获取更多信息

<?php

use Maesbox\ApiBundle\BaseClass\BaseRestController;

class AppController extends BaseRestController
{

}

exception listener

该包提供一个异常监听器，以便将异常转换为JSON响应

将这些行添加到 config.yml

maesbox_api:
	exception_listener: true