开发PHP RESTful API需理解HTTP协议与REST设计原则,使用GET、POST、PUT、DELETE等方法操作资源。2. 项目结构应包含入口文件index.php、数据库配置、模型和响应工具。3. 通过.htaccess实现URL重写,统一请求入口。4. index.php解析请求路径与方法,调用对应逻辑处理并返回JSON格式数据。

开发PHP RESTful API,核心是理解HTTP协议与后端逻辑的结合。你需要用PHP处理请求、返回标准格式的数据(通常是JSON),并遵循REST设计原则。下面从基础结构到实际编码一步步说明如何开发一个简单但规范的PHP RESTful API。
1. 理解RESTful API基本概念
REST(Representational State Transfer)是一种设计风格,不是强制标准。它利用HTTP动词来操作资源:
- GET:获取资源
- POST:创建资源
- PUT:更新资源(全量)
- PATCH:部分更新资源
- DELETE:删除资源
例如,对用户资源的操作:
- GET /users → 获取用户列表
- GET /users/1 → 获取ID为1的用户
- POST /users → 创建新用户
- PUT /users/1 → 更新整个用户信息
- DELETE /users/1 → 删除用户
2. 搭建基础项目结构
建议使用简洁的目录结构:
立即学习“PHP免费学习笔记(深入)”;
api/├── index.php # 入口文件
├── config/database.php # 数据库连接
├── models/User.php # 用户模型
└── utils/response.php # 响应工具函数
确保服务器支持重写规则(如Apache的mod_rewrite),使用.htaccess隐藏index.php:
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php?path=$1 [QSA,L]
3. 编写入口文件 index.php
这是所有请求的统一入口,负责解析路径和方法:
```php json; charset=UTF-8"); header("Access-Control-Allow-Origin: *"); header("Access-Control-Allow-Methods: GET, POST, PUT, DELETE, PATCH"); header("Access-Control-Allow-Headers: Content-Type");$path = $_GET['path'] ?? ''; $method = $_SERVER['REQUEST_METHOD'];
require_once 'config/database.php'; require_once 'models/User.php';
$user = new User($pdo);
switch ($path) { case '': if ($method === 'GET') { echo json_encode($user->getAll()); } else { http_response_code(405); echo json_encode(['error' => 'Method not allowed']); } break;
case 'users':
if ($method === 'GET') {
echo json_encode($user->getAll());
} elseif ($method === 'POST') {
$data = json_decode(file_get_contents('php://input'), true);
$result = $user->create($data);
echo json_encode($result);
} else {
http_response_code(405);
echo json_encode(['error' => 'Method not supported']);
}
break;
case preg_match('/^users\/(\d+)$/', $path, $matches) ? $path : null:
$id = $matches[1];
if ($method === 'GET') {
$result = $user->getById($id);
echo $result ? json_encode($result) : json_encode(['error' => 'Not found']);
} elseif ($method === 'PUT') {
$data = json_decode(file_get_contents('php://input'), true);
$result = $user->update($id, $data);
echo json_encode(['success' => $result]);
} elseif ($method === 'DELETE') {
$result = $user->delete($id);
echo json_encode(['success' => $result]);
} else {
http_response_code(405);
echo json_encode(['error' => 'Method not allowed']);
}
break;
default:
http_response_code(404);
echo json_encode(['error' => 'Route not found']);}
4. 数据库与模型设计
以MySQL为例,先创建用户表:
```sql CREATE TABLE users ( id INT AUTO_INCREMENT PRIMARY KEY, name VARCHAR(100) NOT NULL, email VARCHAR(100) UNIQUE NOT NULL, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP );
在User.php中封装CRUD操作:
}
5. 处理错误与返回标准格式
建议统一响应结构,便于前端解析:
```php // 成功响应 { "success": true, "data": { ... } } // 错误响应 { "success": false, "error": "User not found" }
可创建一个工具函数来简化输出:
```php function sendResponse($data, $statusCode = 200) { http_response_code($statusCode); echo json_encode($data, JSON_UNESCAPED_UNICODE); exit; } ```6. 安全与最佳实践
- 始终验证输入数据(过滤、类型检查)
- 使用预处理语句防止SQL注入
- 开启HTTPS传输敏感信息
- 添加身份认证(如JWT或API Key)
- 记录日志用于调试和监控
- 限制请求频率防止滥用
基本上就这些。一个简单的PHP RESTful API并不复杂,关键是结构清晰、接口规范、安全可靠。随着需求增长,可以引入框架(如Slim、Laravel)来提升开发效率和维护性。










