Rest API
我之前在此网站上编写过文档 ，以描述如何在 Symfony 上创建 Web 服务
我将再次编写 symfony> = 3 版本的教程。
我们认为我们在已配置的 Symfony Framework 版本上安装了 Web 服务器。你也必须安装 composer （php 包管理器）。
为简单起见，如果安装了 composer，请在终端/命令提示符下键入：
composer create-project symfony/framework-standard-edition example "3.1.*"
这将在当前目录中创建一个名为 example 的新目录，其中包含 symfony 框架的标准安装。
你必须安装这 2 个 Bundles：JMSSerializer Bundle（扩展框架组件序列化程序）和 FOSRest Bundle（扩展框架组件路由和控制器…）
你可以这样做（在示例目录中）：
composer require jms/serializer-bundle "~0.13"
composer require friendsofsymfony/rest-bundle
别忘了在 AppKernel 中激活它们！
在这里你不能使用：
composer create-project gimler/symfony-rest-edition --stability=dev example
因为它基于 Symfony 2.8 版本。
首先，创建自己的（示例）Bundle（在 Symfony 目录中）：
php bin/console generate:bundle
php bin/console doctrine:create:database
想象一下，我们想要对此 StackOverFlower 实体进行 CRUD（创建/读取/更新/删除）：
# src/ExampleBundle/Resources/config/doctrine/StackOverFlower.orm.yml
ExampleBundle\Entity\StackOverFlower:
type: entity
table: stackoverflower
id:
id:
type: integer
generator: { strategy: AUTO }
fields:
name:
type: string
length: 100
配置你的 Bundle：
#app/config/config.yml
fos_rest:
format_listener:
rules:
- { path: '^/stackoverflower', priorities: ['xml', 'json'], fallback_format: xml, prefer_extension: true }
- { path: '^/', priorities: [ 'text/html', '*/*'], fallback_format: html, prefer_extension: true }
生成此实体：
php bin/console doctrine:generate:entity StackOverFlower
php bin/console doctrine:schema:update --force
制作一个控制器：
#src/ExampleBundle/Controller/StackOverFlowerController.php
namespace ExampleBundle\Controller;
use FOS\RestBundle\Controller\FOSRestController;
use Symfony\Component\HttpFoundation\Request;
use FOS\RestBundle\Controller\Annotations\Get;
use FOS\RestBundle\Controller\Annotations\Post;
use FOS\RestBundle\Controller\Annotations\Delete;
use ExampleBundle\Entity\StackOverFlower;
class StackOverFlowerController extends FOSRestController
{
/**
* findStackOverFlowerByRequest
*
* @param Request $request
* @return StackOverFlower
* @throws NotFoundException
*/
private function findStackOverFlowerByRequest(Request $request) {
$id = $request->get('id');
$user = $this->getDoctrine()->getManager()->getRepository("ExampleBundle:StackOverFlower")->findOneBy(array('id' => $id));
return $user;
}
/**
* validateAndPersistEntity
*
* @param StackOverFlower $user
* @param Boolean $delete
* @return View the view
*/
private function validateAndPersistEntity(StackOverFlower $user, $delete = false) {
$template = "ExampleBundle:StackOverFlower:example.html.twig";
$validator = $this->get('validator');
$errors_list = $validator->validate($user);
if (0 === count($errors_list)) {
$em = $this->getDoctrine()->getManager();
if ($delete === true) {
$em->remove($user);
} else {
$em->persist($user);
}
$em->flush();
$view = $this->view($user)
->setTemplateVar('user')
->setTemplate($template);
} else {
$errors = "";
foreach ($errors_list as $error) {
$errors .= (string) $error->getMessage();
}
$view = $this->view($errors)
->setTemplateVar('errors')
->setTemplate($template);
}
return $view;
}
/**
* newStackOverFlowerAction
*
* @Get("/stackoverflower/new/{name}")
*
* @param Request $request
* @return String
*/
public function newStackOverFlowerAction(Request $request)
{
$user = new StackOverFlower();
$user->setName($request->get('name'));
$view = $this->validateAndPersistEntity($user);
return $this->handleView($view);
}
/**
* editStackOverFlowerAction
*
* @Get("/stackoverflower/edit/{id}/{name}")
*
* @param Request $request
* @return type
*/
public function editStackOverFlowerAction(Request $request) {
$user = $this->findStackOverFlowerByRequest($request);
if (! $user) {
$view = $this->view("No StackOverFlower found for this id:". $request->get('id'), 404);
return $this->handleView($view);
}
$user->setName($request->get('name'));
$view = $this->validateAndPersistEntity($user);
return $this->handleView($view);
}
/**
* deleteStackOverFlowerAction
*
* @Get("/stackoverflower/delete/{id}")
*
* @param Request $request
* @return type
*/
public function deleteStackOverFlowerAction(Request $request) {
$user = $this->findStackOverFlowerByRequest($request);
if (! $user) {
$view = $this->view("No StackOverFlower found for this id:". $request->get('id'), 404);
return $this->handleView();
}
$view = $this->validateAndPersistEntity($user, true);
return $this->handleView($view);
}
/**
* getStackOverFlowerAction
*
* @Get("/stackoverflowers")
*
* @param Request $request
* @return type
*/
public function getStackOverFlowerAction(Request $request) {
$template = "ExampleBundle:StackOverFlower:example.html.twig";
$users = $this->getDoctrine()->getManager()->getRepository("ExampleBundle:StackOverFlower")->findAll();
if (0 === count($users)) {
$view = $this->view("No StackOverFlower found.", 404);
return $this->handleView();
}
$view = $this->view($users)
->setTemplateVar('users')
->setTemplate($template);
return $this->handleView($view);
}
}
不要告诉我这是一个胖控制器，它就是一个例子！
创建模板：
#src/ExampleBundle/Resources/views/StackOverFlower.html.twig
{% if errors is defined %}
{{ errors }}
{% else %}
{% if users is defined %}
{{ users | serialize }}
{% else %}
{{ user | serialize }}
{% endif %}
{% endif %}
你刚刚制作了第一个 RESTFul API！
你可以在以下位置进行测试： http：//your-server-name/your-symfony-path/app_dev.php/stackoverflower/new/test 。
正如你在数据库中看到的那样，创建了一个名为 test 的新用户。
你可以在我的 GitHub 帐户上查看此代码的完整工作示例，一个分支包含更多真实路线…
这是一个非常基本的例子，不要让它在生产环境中，你必须用 apikey 来保护你的 API！
未来的例子，可能是？