RESTful API开发需遵循REST架构原则,使用HTTP方法操作资源;2. PHP通过合理目录结构与入口文件实现路由解析;3. 结合数据库连接、模型与控制器完成用户数据操作示例。

构建RESTful API是现代Web开发中的常见需求,PHP作为广泛使用的服务器端语言,非常适合用来开发高效、稳定的RESTful接口。下面是一个实用的PHP RESTful API开发指南,帮助你从零开始搭建一个标准的API服务。
理解RESTful架构核心原则
REST(Representational State Transfer)是一种设计风格,不是协议也不是标准。它依赖于HTTP协议的语义来实现资源的操作。关键点包括:
- 每个URL代表一种资源,例如 /users 表示用户集合,/users/1 表示ID为1的用户
- 使用标准HTTP方法表达操作:GET(读取)、POST(创建)、PUT(更新)、DELETE(删除)
- 无状态通信:每次请求都应包含完整信息,服务器不保存客户端上下文
- 返回统一格式的数据,通常为JSON
基础项目结构设计
一个清晰的目录结构有助于后期维护。建议如下组织文件:
/api /index.php # 入口文件 /config/database.php # 数据库连接 /models/User.php # 用户模型 /controllers/UserController.php # 控制器
入口文件 index.php 使用 PHP 的内置 Web 服务器或 Apache/Nginx 指向该文件,通过解析 $_SERVER['REQUEST_URI'] 和 $_SERVER['REQUEST_METHOD'] 来路由请求。
立即学习“PHP免费学习笔记(深入)”;
实现简单的用户API示例
以获取和操作用户数据为例,展示核心代码逻辑。
GarbageSort垃圾识别工具箱是一个基于uni-app开发的微信小程序,使用SpringBoot2搭建后端服务,使用Swagger2构建Restful接口文档,实现了文字查询、语音识别、图像识别其垃圾分类的功能。前端:微信小程序 采用 uni-app 开发框架,uni-app 是一个使用 Vue.js 开发所有前端应用的框架,开发者编写一套代码,可发布到iOS、Android、H5、以及各
数据库连接(database.php):
```php $pdo = new PDO("mysql:host=$host;dbname=$db;charset=$charset", $user, $pass); $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); ?>控制器处理逻辑(UserController.php):
```php pdo = $pdo; } // GET /users - 获取所有用户 public function getAll() { $stmt = $this->pdo->query("SELECT id, name, email FROM users"); $users = $stmt->fetchAll(PDO::FETCH_ASSOC); header('Content-Type: application/json'); echo json_encode(['success' => true, 'data' => $users]); } // GET /users/{id} public function getById($id) { $stmt = $this->pdo->prepare("SELECT id, name, email FROM users WHERE id = ?"); $stmt->execute([$id]); $user = $stmt->fetch(PDO::FETCH_ASSOC); if ($user) { echo json_encode(['success' => true, 'data' => $user]); } else { http_response_code(404); echo json_encode(['success' => false, 'message' => '用户不存在']); } } // POST /users - 创建用户 public function create() { $input = json_decode(file_get_contents('php://input'), true); $name = $input['name']; $email = $input['email']; $stmt = $this->pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)"); if ($stmt->execute([$name, $email])) { http_response_code(201); echo json_encode(['success' => true, 'message' => '用户创建成功']); } } } ?>
路由分发(index.php):
```php json'); header('Access-Control-Allow-Origin: *'); header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE'); header('Access-Control-Allow-Headers: Content-Type');$requestUri = explode('/', trim($_SERVER['REQUEST_URI'], '/')); $method = $_SERVER['REQUEST_METHOD'];
require_once 'controllers/UserController.php'; $controller = new UserController($pdo);
if ($requestUri[0] === 'users') { if ($method === 'GET') { if (isset($requestUri[1])) { $controller->getById((int)$requestUri[1]); } else { $controller->getAll(); } } elseif ($method === 'POST') { $controller->create(); } } ?>
安全与最佳实践建议
实际部署中还需考虑以下几点:
- 对输入数据进行过滤和验证,防止SQL注入和XSS攻击
- 使用 PDO预处理语句 避免拼接SQL
- 添加身份认证机制,如JWT或API Token
- 记录日志便于调试和监控
- 统一错误响应格式,提升前端处理效率
- 启用HTTPS保障传输安全
基本上就这些。用PHP写RESTful API并不复杂,关键是遵循规范、结构清晰、注重安全。随着业务增长,可以引入框架如Slim或Laravel来提升开发效率。










