如何使用 PHP 构建 RESTful API？

如何使用 PHP 构建 RESTful API？创建项目并配置路由以处理客户端请求。创建控制器来处理路由中的方法。通过映射对象关系将实体映射到数据库表。运行 API 并处理身份验证、数据验证和错误处理。

如何使用 PHP 构建 RESTful API

简介

RESTful API 是一种网络应用程序接口，它遵循 REST（Representational State Transfer）原则。REST API 允许客户端与服务器交互，以获取、创建、更新或删除数据。使用 PHP 构建 RESTful API 非常简单，本文将逐步指导你完成这个过程。

先决条件

• PHP 7.4 或更高版本
• Composer
• 数据库（可选）

创建项目

首先，使用 Composer 创建一个新项目：

composer create-project symfony/skeleton my-api

配置路由

在 config/routes.yaml 中定义路由，用于处理来自客户端的请求：

# config/routes.yaml
users:
    path: /users
    methods: [GET, POST]
    controller: App\Controller\UserController

创建控制器

创建控制器来处理路由中的方法：

# src/Controller/UserController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class UserController extends AbstractController
{
    /**
     * @Route("/users", methods={"GET"})
     */
    public function index(): Response
    {
        // 获取用户数据
        $users = $this->getDoctrine()
            ->getRepository(User::class)
            ->findAll();

        // 返回 JSON 响应
        return $this->json($users);
    }
}

实战案例：构建用户 API

以下是一个构建简单的用户 API 的实战案例：

# src/Entity/User.php
namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity
 */
class User
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255)
     */
    private $name;

    // getters and setters omitted for brevity
}

映射对象关系

使用 Doctrine ORM 将用户实体映射到数据库表：

# config/packages/doctrine.yaml
doctrine:
    dbal:
        driver: pdo_mysql
        url: '%env(DATABASE_URL)%'
    orm:
        auto_generate_proxy_classes: true
        naming_strategy: doctrine.orm.naming_strategy.underscore

运行 API

使用以下命令运行 API：

php bin/console server:run

现在，你可以在浏览器中访问 /users 来获取用户数据。

其他考虑因素

• 身份验证和授权：确保 API 受到身份验证和授权的保护，以防止未经授权的访问。
• 数据验证：验证客户端请求中的输入数据，以防止恶意数据进入系统。
• 错误处理：处理 API 呼叫中的错误并为客户端提供有意义的错误消息。
• 版本控制：考虑使用版本控制来跟踪 API 更改并允许客户端指定所需的版本。