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！
未來的例子，可能是？