PHP如何使用RESTful API_PHP RESTful API的设计与实现方法详解

答案:PHP实现RESTful API需理解HTTP方法与资源操作对应关系,通过路由分发请求至控制器,由控制器调用模型处理数据并返回JSON响应。1. 使用$_SERVER获取请求路径与方法,解析URI并映射到对应控制器;2. 控制器根据HTTP方法调用模型的增删改查方法;3. 模型使用PDO安全操作数据库,防止SQL注入;4. 统一返回JSON格式数据,并设置正确HTTP状态码,如200、201、404等;5. 通过json_decode读取POST/PUT数据,确保输入验证与错误处理。该结构清晰,便于维护扩展。

PHP 实现 RESTful API 并不复杂,核心在于理解 HTTP 方法与资源操作的对应关系,并通过路由、控制器和数据处理完成请求响应。下面详细介绍设计与实现方法。

RESTful API 基本概念

REST(Representational State Transfer)是一种基于 HTTP 协议的软件架构风格。RESTful API 使用标准的 HTTP 方法对资源进行操作:

  • GET:获取资源
  • POST:创建资源
  • PUT:更新资源(全量)
  • PATCH:部分更新资源
  • DELETE:删除资源

每个 URL 表示一个资源,例如:/api/users 表示用户集合,/api/users/1 表示 ID 为 1 的用户。

项目结构设计

合理的目录结构有助于维护和扩展。一个简单的结构如下:

/api
  index.php          # 入口文件
  routes.php         # 路由分发
  controllers/
    UserController.php
  models/
    User.php
  config/
    database.php

入口文件 index.php 接收所有请求,通过路由转发到对应控制器。

路由解析与请求分发

使用 PHP 的 $_SERVER['REQUEST_URI']$_SERVER['REQUEST_METHOD'] 获取路径和方法。

示例路由处理逻辑:

$uri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
$uri = explode('/', trim($uri, '/'));
$method = $_SERVER['REQUEST_METHOD'];

根据路径判断资源类型,如 users 调用 UserController,再结合 ID 判断是列表还是单条操作。

可使用简单 switch 或数组映射实现路由分发:

if ($uri[0] === 'users') {
  require_once 'controllers/UserController.php';
  $controller = new UserController();
  if (isset($uri[1]) && is_numeric($uri[1])) {
    $id = (int)$uri[1];
    if ($method === 'GET') $controller->getById($id);
    if ($method === 'PUT') $controller->update($id);
    if ($method === 'DELETE') $controller->delete($id);
  } else {
    if ($method === 'GET') $controller->getAll();
    if ($method === 'POST') $controller->create();
  }
}

控制器与数据处理

控制器负责接收请求、调用模型、返回 JSON 响应。

UserController 示例方法:

class UserController {
  public function getAll() {
    $users = User::fetchAll();
    $this->jsonResponse($users);
  }

  public function getById($id) {
    $user = User::findById($id);
    if ($user) {
      $this->jsonResponse($user);
    } else {
      http_response_code(404);
      echo json_encode(['error' => 'User not found']);
    }
  }

  private function jsonResponse($data) {
    header('Content-Type: application/json');
    echo json_encode($data);
  }
}

数据库交互(Model 层)

使用 PDO 进行安全的数据库操作,避免 SQL 注入。

class User {
  private static $pdo;

  public static function fetchAll() {
    $stmt = self::$pdo->query("SELECT * FROM users");
    return $stmt->fetchAll(PDO::FETCH_ASSOC);
  }

  public static function findById($id) {
    $stmt = self::$pdo->prepare("SELECT * FROM users WHERE id = ?");
    $stmt->execute([$id]);
    return $stmt->fetch(PDO::FETCH_ASSOC);
  }

  public static function create($data) {
    $stmt = self::$pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
    return $stmt->execute([$data['name'], $data['email']]);
  } }

处理 POST 和 PUT 数据

POST 和 PUT 请求的数据通常在输入流中,需手动读取:

$input = json_decode(file_get_contents('php://input'), true);

之后可将 $input 传入模型进行处理。记得验证数据完整性,如检查 name 和 email 是否存在。

错误处理与状态码

正确使用 HTTP 状态码提升 API 可读性:

  • 200:成功获取
  • 201:创建成功(POST 后常用)
  • 400:请求参数错误
  • 404:资源未找到
  • 500:服务器内部错误

例如创建成功后设置状态码:

http_response_code(201);
echo json_encode(['id' => self::$pdo->lastInsertId()]);

基本上就这些。掌握路由分发、控制器调度、模型操作和 JSON 返回,就能用原生 PHP 写出清晰的 RESTful API。实际开发中也可使用框架如 Slim 或 Lumen 简化流程,但理解底层原理更重要。