PHP RESTful介绍

封面图 • 2025-11-02 • PHP

PHP 是一种广泛用于 Web 开发的服务器端脚本语言，而 RESTful（Representational State Transfer）是一种基于 HTTP 协议的 API 设计风格。在 PHP 中实现 RESTful API 是非常常见的做法，它允许客户端通过标准的 HTTP 方法（如 GET、POST、PUT、DELETE）与服务器进行交互。

---

## 一、什么是 RESTful？

REST 是一种架构风格，不是具体的协议或标准。它的核心思想是：

- **资源**：每个资源都有一个唯一的 URL。
- **状态无关**：每次请求都包含所有必要的信息。
- **使用标准 HTTP 方法**：GET、POST、PUT、DELETE 等来操作资源。

### 常见的 HTTP 方法对应操作：

| HTTP 方法 | 操作       | 示例                     |
|-----------|------------|--------------------------|
| GET       | 获取资源   | `GET /users`             |
| POST      | 创建资源   | `POST /users`            |
| PUT       | 更新资源   | `PUT /users/1`           |
| DELETE    | 删除资源   | `DELETE /users/1`        |

---

## 二、PHP 实现 RESTful API 的基本步骤

### 1. 设置路由（URL 路由）

PHP 默认不支持直接通过 URL 路径访问不同的方法，需要借助框架或手动解析 URL。

#### 示例（手动处理）：

```php
<?php
// index.php

$method = $_SERVER['REQUEST_METHOD'];
$requestUri = $_SERVER['REQUEST_URI'];

// 分割 URL
$parts = explode('/', trim($requestUri, '/'));

// 判断是否为用户资源
if ($parts[0] === 'users') {
    $userId = isset($parts[1]) ? $parts[1] : null;

switch ($method) {
        case 'GET':
            if ($userId) {
                // 获取单个用户
                echo "Get user: $userId";
            } else {
                // 获取所有用户
                echo "Get all users";
            }
            break;
        case 'POST':
            // 创建用户
            echo "Create a new user";
            break;
        case 'PUT':
            if ($userId) {
                // 更新用户
                echo "Update user: $userId";
            }
            break;
        case 'DELETE':
            if ($userId) {
                // 删除用户
                echo "Delete user: $userId";
            }
            break;
        default:
            http_response_code(405);
            echo "Method not allowed";
    }
} else {
    http_response_code(404);
    echo "Resource not found";
}
```

---

### 2. 使用 PHP 框架简化开发

为了更高效地开发 RESTful API，通常会使用 PHP 框架，比如：

- **Laravel**：功能强大，内置 RESTful 支持。
- **Slim**：轻量级，适合构建 RESTful API。
- **Fakeroute** 或 **Route PHP**：简单的路由库。

#### Laravel 示例（简单说明）：

```php
// routes/api.php

Route::get('/users', [UserController::class, 'index']);
Route::post('/users', [UserController::class, 'store']);
Route::get('/users/{id}', [UserController::class, 'show']);
Route::put('/users/{id}', [UserController::class, 'update']);
Route::delete('/users/{id}', [UserController::class, 'destroy']);
```

---

## 三、RESTful API 的常见设计原则

1. **使用名词表示资源**，而不是动词。
   - ✅ `/users`
   - ❌ `/getUsers`

2. **使用 HTTP 方法表示动作**。
   - ✅ `GET /users` → 获取用户列表
   - ✅ `POST /users` → 创建用户

3. **版本控制**（可选）：
   - `GET /api/v1/users`

4. **返回 JSON 格式数据**（常用）：
   ```json
   {
     "status": "success",
     "data": { ... }
   }
   ```

5. **错误处理**：
   - 返回合适的 HTTP 状态码（如 404、400、500）
   - 返回错误信息（如 `{"error": "User not found"}`）

---

## 四、PHP RESTful API 示例（使用 Slim 框架）

安装 Slim：

```bash
composer require slim/slim
```

示例代码：

```php
<?php
require 'vendor/autoload.php';

$app = new \Slim\App();

// 获取所有用户
$app->get('/users', function ($request, $response) {
    return $response->withJson(['users' => ['Alice', 'Bob']]);
});

// 获取单个用户
$app->get('/users/{id}', function ($request, $response, $args) {
    $id = $args['id'];
    return $response->withJson(['user' => "User $id"]);
});

// 创建用户
$app->post('/users', function ($request, $response) {
    $data = $request->getParsedBody();
    return $response->withJson(['message' => 'User created', 'data' => $data]);
});

$app->run();
```

---

## 五、总结

| 项目         | 内容                                                                 |
|--------------|----------------------------------------------------------------------|
| RESTful API  | 基于 HTTP 的 API 设计风格，使用标准方法操作资源                      |
| PHP 实现     | 可以手动处理 URL，也可以使用框架（如 Laravel、Slim）                  |
| HTTP 方法    | GET、POST、PUT、DELETE 对应 查、增、改、删                         |
| 数据格式     | 通常使用 JSON                                                      |
| 框架推荐     | Laravel、Slim、Phalcon 等                                            |

---

如果你有具体的项目需求（比如如何认证、分页、缓存等），我可以进一步帮你设计和实现！