前言
RESTful API 已经成为了现代 web 应用程序的标准。不论是构建单页面应用程序，还是构建移动应用程序，RESTful API 都成为了数据的主要来源。
Symfony 是一款目前非常流行的 PHP 框架。它提供了一套完整而且易于使用的工具，让开发人员能够快速构建 RESTful API。在本文中，我们将介绍如何使用 Symfony 开发 RESTful API。
Symfony 简介
Symfony 是一款基于 PHP 的 web 应用程序框架。它提供了一套完整的工具和组件，用于构建复杂的 web 应用程序和 RESTful API。
Symfony 使用 MVC（Model-View-Controller）架构，它将应用程序和数据分离开来，从而使得代码更容易维护和扩展。Symfony 还提供了自动化测试工具，使得开发人员能够快速测试他们的代码。
开始使用 Symfony
安装 Symfony
使用 Composer 来安装 Symfony。在命令行中运行以下命令：
$ composer create-project symfony/skeleton my-project
这里我们使用 symfony/skeleton 模板来创建项目。这个模板包含了 Symfony 的核心功能，并且非常适合构建 RESTful API。
创建控制器
控制器是 Symfony 中实现业务逻辑的主要地方。我们可以通过控制器来响应来自客户端的请求，并返回适当的响应。
创建控制器非常简单。在 src/Controller 目录中创建一个新的 ApiController.php 文件，并添加以下内容：
-- -------------------- ---- -------
-----
--------- ---------------
--- ------------------------------------------
--- -------------------------------------------
---
- --------------
--
----- -------------
-
---
- ----------------------- ----------------- ----------------- ---------
--
------ -------- ------------ ------- --------
-
------ --- ----------------------- ----- --------
-
-这个控制器定义了一个 /api/hello/{name} 路由，并在访问该路由时返回一个 Hello name! 的响应。如果没有传递 name 参数，则默认为 world。
启动内置的 Web 服务器
Symfony 提供了一个简单的内置 Web 服务器，可以用来快速测试我们的应用程序。在命令行中运行以下命令来启动内置的 Web 服务器：
$ cd my-project $ php bin/console server:start
这会在默认的端口上启动内置 Web 服务器。现在，在浏览器中输入 http://localhost:8000/api/hello，应该会看到 Hello world! 的响应。
使用 Doctrine 连接数据库
Symfony 提供了一个名为 Doctrine 的 ORM（对象关系映射）工具，用于连接和操作数据库。我们可以使用 Doctrine 来创建和管理数据库表，插入和更新数据，以及实现其他数据库相关操作。
首先，我们需要使用 Composer 安装 Doctrine ORM。在命令行中运行以下命令：
$ composer require doctrine maker twig-bundle form validator orm
这会安装需要用到的所有 Doctrine 相关的包。
接下来，我们需要设置数据库连接。在项目的 .env 文件中，找到并修改以下行：
# .env DATABASE_URL=mysql://user:password@127.0.0.1:3306/my_database
将其中的用户名、密码和数据库名修改为你的实际设置。
接着，我们需要创建一个实体类来映射数据库表。在 src/Entity 目录中创建一个 Post.php 文件，并添加以下内容：
-- -------------------- ---- -------
-----
--------- -----------
--- -------------------- -- ----
---
- -----------
- -----------------------
--
----- ----
-
---
- -------
- -------------------
- ---------------------------
--
------- ----
---
- -------------------------- -----------
--
------- -------
---
- ------------------------
--
------- ---------
-- ------- --- ----------
-这个实体类定义了一个名为 post 的表，包含了 id、title 和 content 三个字段。
接下来，我们需要创建一个控制器来操作这个实体类。在 src/Controller 目录中创建一个 PostController.php 文件，并添加以下内容：
-- -------------------- ---- -------
-----
--------- ---------------
--- ----------------
--- -----------------------------------------
--- ------------------------------------------
--- -------------------------------------------
--- --------------------------------------------------------
--- -------------------------------------------------------------
---
- --------------------
--
----- -------------- ------- ------------------
-
---
- ----------- ---------------------
- --------------
--
------ -------- ------- --------
-
----------- - -------------------------------------------------
------ - -----------------------
------ --------------------
-
---
- --------------- ---------------------
- --------------
--
------ -------- --------- ------- --------
-
------ -------------------
-
---
- ----------- -----------------------
- ---------------
--
------ -------- -------------- ---------- --------
-
----- - --- -------
----- - -------------------------------
--------------
----------------
------------
-------------------------------
-- ------------------ -
-------------- - -----------------------------------
-------------------------------
------------------------
------ -------------------
-
------ ------------------------------- -----
-
---
- --------------- -----------------------
- --------------
--
------ -------- -------------- --------- ---- ------- --------
-
----- - -------------------------------
--------------
----------------
------------
-------------------------------
-- ------------------ -
-------------- - -----------------------------------
------------------------
------ -------------------
-
------ ------------------------------- -----
-
---
- --------------- -----------------------
- -----------------
--
------ -------- ----------- ------- --------
-
-------------- - -----------------------------------
------------------------------
------------------------
------ --- -----------
-
-这个控制器定义了五个路由：GET /api/posts、GET /api/posts/{id}、POST /api/posts、PUT /api/posts/{id} 和 DELETE /api/posts/{id}。这些路由用于获取、创建、更新和删除 post 实体的数据。
在 list() 方法中，我们通过 $repository->findAll() 获取所有的 post 实体，并通过 json() 方法将它们转换为 JSON 格式的响应数据。
在 show() 方法中，我们通过 findBy() 方法查找到指定的 post 实体，并将其转换为 JSON 格式的响应数据。
在 create() 方法中，我们使用 Symfony 的表单组件来创建一个包含 title 和 content 两个字段的表单。当表单提交时，我们使用 $entityManager->persist($post) 和 $entityManager->flush() 方法来将数据保存到数据库，并返回保存后的 post 实体。
在 update() 方法中，我们使用相同的方法来更新数据库中的 post 实体。
在 delete() 方法中，我们使用 $entityManager->remove($post) 和 $entityManager->flush() 方法来删除数据库中的 post 实体。
测试 API
使用 PHPUnit 作为测试框架可以非常方便地测试我们的 RESTful API。
在命令行中，运行以下命令创建一个测试：
$ php bin/console make:functional-test
然后在 tests/Controller/Api 目录中，找到并编辑 PostControllerTest.php 文件。在这个文件中，可以编写测试用例，用于测试我们的 API 是否按照预期工作。
例如，我们可以使用 testList() 方法来测试 GET /api/posts 路由的工作方式：
-- -------------------- ---- -------
------ -------- ----------
-
------- - -----------------------
-------- - ----------------------- --------------
--------------------
----
---------------------------------------
--
----------------------------------------
------------------------ ------------------------ -- ----- ------------------------------- ------------------------ -- ------ ----------
------------------------------------
--
-在这个测试用例中，我们使用 $client->request('GET', '/api/posts') 来发送一个 GET 请求，并断言该请求的结果与预期的值相同。
除了列表测试之外，我们还可以编写更多的测试用例，例如测试创建、更新和删除实体的功能。
总结
Symfony 是一个强大的 PHP 框架，非常适合用于构建 RESTful API。它提供了一套完整的工具和组件，使得开发人员可以轻松地构建出高质量的 API。
在本文中，我们学习了如何使用 Symfony 创建 RESTful API。我们首先创建一个简单的控制器，然后介绍了如何连接和操作数据库，最后使用 PHPUnit 编写了一些测试用例来测试我们的 API 是否按照预期工作。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6491379048841e9894f385d4