使用 RESTFul API
REpresentational State Transfer(REST) 是一种用于 Web 开发的架构风格，由 Roy Fielding 在 2000 年引入和定义。
在 wiki 上看到它： REST wiki
它基于 HTTP 协议（ Wiki 上的 HTTP ），HTTP 请求（GET，POST，PATCH，DELETE …）/响应代码（404,400,200,201,500 ……）和主体结构。
这是将数据暴露给 Internet 上另一个系统的好方法。
想象一下，你想制作一个 RESTFul api 来管理本地数据库上的 StackOverFlower（用户）。
让我们举个例子吧！
Symfony 2.8 框架
- 网络服务器 ：
你必须在本地计算机上安装和配置 Web 服务器，请参阅 Wamp 或 Lamp 或 Mamp ：你必须拥有最新版本的 PHP（ !!! Symfony 要求!!! ）
- Php cli 和作曲家：
你必须配置 PHP cli（在我们的系统上有所不同），在我们的朋友 Google 中输入“PHP cli [OS-NAME] how-to”！ 你必须安装 composer，请参阅 Composer 安装
- Symfony：
你必须安装 Symfony 2.8（使用 composer，这是更好的方法），打开终端（或 Windows 上的 cmd）并转到 Web 服务器路径。
Symfony 2 使用了一种更好的结构类型：Bundles。所有都是 Symfony 的套装！ 我们可以在上面测试它。
cd /your-web-server-path/
composer create-project symfony/framework-standard-edition example "2.8.*"
转到树结构，请参阅：Symfony 2.8 安装在 example 目录中。
- JMSSerializer Bundle 上的 FOSRest（适用于 FriendsOfSymfony）：
你必须安装这两个 Bundles：
JMSSerializer（ 安装 ）：
composer require jms/serializer-bundle "~0.13"
FosRestBundle（ 安装 ）：
composer require friendsofsymfony/rest-bundle
别忘了在 AppKernel.php 中激活它们！
- 基本配置：
制作你自己的示例包并创建数据库。
cd /path/to/your/symfony/
php app/console generate:bundle
php app/console doctrine:generate:database
转到 Symfony 2.8 应用程序配置文件的底部，然后粘贴它：
#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 }
创建你的 doctrine 目录（“example / src / ExampleBundle / Entity”）和资源文件（“StackOverFlower.orm.yml”）：
# 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
生成实体和更新架构：
php app/console doctrine:generate:entity StackOverFlower
php app/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 (count($errors_list) == 0) {
$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 (count($users) === 0) {
$view = $this->view("No StackOverFlower found.", 404);
return $this->handleView();
}
$view = $this->view($users)
->setTemplateVar('users')
->setTemplate($template);
return $this->handleView($view);
}
}
设置默认的 Twig 视图：
#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 的新用户。
你可以在以下网址获取 stackoverflower 列表： http：//your-server-name/your-symfony-path/app_dev.php/stackoverflowers
你在此示例的 github 帐户上有一个完整的示例： Git Hub 示例 ，在此示例的 master 分支上，以及“real-routes”分支上的一个示例，其中包含更合适的 URL（如 POST 和 DELETE）。
稍后再见，以获得 SOAP 的示例！
最好的祝福，
马蒂厄