如何使用 PHP 构建 RESTful API？-php教程-PHP中文网

如何使用 PHP 构建 RESTful API？

WBOY

发布： 2024-04-19 14:39:02

原创

1141人浏览过

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

如何使用 PHP 构建 RESTful API？

如何使用 PHP 构建 RESTful API

简介

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

立即学习“PHP免费学习笔记（深入）”；

先决条件

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

登录后复制

创建控制器

MixPHP3.0.27

MixPHP 是一个 PHP 命令行模式开发框架；基于 Vega 驱动的 HTTP 可以同时支持 Swoole、WorkerMan、FPM、CLI-Server 生态，并且可以无缝切换；V3 是一个高度解耦的版本，整体代码基于多个独立的模块构建，即便用户不使用我们的脚手架，也可以使用这些独立模块，并且全部模块都支持原生开发。例如：你可以只使用 mix/vega 来搭配 laravel orm 使用

查看详情

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

# 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：