PHP搭建RESTfulAPI教程详解
时间:2025-12-19 10:40:30 176浏览 收藏
小伙伴们对文章编程感兴趣吗?是否正在学习相关知识点?如果是,那么本文《搭建RESTful API接口 PHP框架教程》,就很适合你,本篇文章讲解的知识点主要包括。在之后的文章中也会多多分享相关知识点,希望对大家的知识积累有所帮助!
答案是搭建基于PHP的RESTful API需理解HTTP动词与资源映射,规划目录结构,配置路由解析。具体包括:定义用户资源的增删改查操作,建立models、controllers等分层目录,通过.htaccess实现URL重写,index.php解析请求路径并分发至对应控制器处理。

搭建一个基于PHP的RESTful API接口并不复杂,只要理解HTTP动词与资源操作之间的映射关系,并合理组织代码结构。以下是使用原生PHP(不依赖框架)构建RESTful API的详细步骤,适合初学者快速上手。
理解RESTful API基本概念
RESTful 是一种设计风格,不是标准。它基于HTTP协议,利用请求方法(GET、POST、PUT、DELETE等)对资源进行操作。例如:
- GET /users:获取用户列表
- GET /users/1:获取ID为1的用户
- POST /users:创建新用户
- PUT /users/1:更新ID为1的用户
- DELETE /users/1:删除ID为1的用户
每个URL代表一种资源,通过HTTP方法决定操作类型。
项目目录结构规划
良好的目录结构有助于后期维护。建议如下布局:
/api ├── index.php # 入口文件 ├── config/database.php # 数据库连接 ├── models/User.php # 用户模型 ├── controllers/UserController.php # 控制器 └── utils/Response.php # 响应工具类
配置入口文件和路由解析
所有请求都应指向 index.php,通过重写URL实现路由解析。在根目录添加 .htaccess 文件:
```apache RewriteEngine On RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d RewriteRule ^(.*)$ index.php?url=$1 [QSA,L] ```在 index.php 中解析路径和参数:
```php $method = $_SERVER['REQUEST_METHOD']; $url = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH); $parts = explode('/', trim($url, '/'));// 路由分发:假设格式为 /api/users[/id] if ($parts[0] === 'api' && $parts[1] === 'users') { require_once 'controllers/UserController.php'; $controller = new UserController();
if (isset($parts[2])) {
$id = $parts[2];
switch ($method) {
case 'GET':
echo json_encode($controller->getById($id));
break;
case 'PUT':
parse_str(file_get_contents('php://input'), $putData);
echo json_encode($controller->update($id, $putData));
break;
case 'DELETE':
echo json_encode($controller->delete($id));
break;
}
} else {
switch ($method) {
case 'GET':
echo json_encode($controller->getAll());
break;
case 'POST':
$data = json_decode(file_get_contents('php://input'), true);
echo json_encode($controller->create($data));
break;
}
}} else { http_response_code(404); echo json_encode(['error' => 'Not Found']); } ?>
<H3>连接数据库并创建模型</H3>
<p>在 config/database.php 中建立PDO连接:</p>
```php
<?php
// config/database.php
$host = 'localhost';
$db = 'api_db';
$user = 'root';
$pass = '';
$charset = 'utf8mb4';
$dsn = "mysql:host=$host;dbname=$db;charset=$charset";
$options = [
PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC
];
try {
$pdo = new PDO($dsn, $user, $pass, $options);
} catch (\PDOException $e) {
throw new \PDOException($e->getMessage(), (int)$e->getCode());
}
?>在 models/User.php 中定义数据操作:
```php class User { private $pdo;public function __construct() {
global $pdo;
$this->pdo = $pdo;
}
public function getAll() {
$stmt = $this->pdo->query("SELECT id, name, email FROM users");
return $stmt->fetchAll();
}
public function getById($id) {
$stmt = $this->pdo->prepare("SELECT id, name, email FROM users WHERE id = ?");
$stmt->execute([$id]);
return $stmt->fetch() ?: ['error' => 'User not found'];
}
public function create($data) {
$stmt = $this->pdo->prepare("INSERT INTO users (name, email) VALUES (?, ?)");
$stmt->execute([$data['name'], $data['email']]);
return ['id' => $this->pdo->lastInsertId(), 'message' => 'User created'];
}
public function update($id, $data) {
$stmt = $this->pdo->prepare("UPDATE users SET name = ?, email = ? WHERE id = ?");
$stmt->execute([$data['name'], $data['email'], $id]);
return $stmt->rowCount() ? ['message' => 'User updated'] : ['error' => 'Update failed'];
}
public function delete($id) {
$stmt = $this->pdo->prepare("DELETE FROM users WHERE id = ?");
$stmt->execute([$id]);
return $stmt->rowCount() ? ['message' => 'User deleted'] : ['error' => 'Delete failed'];
}} ?>
<H3>编写控制器处理逻辑</H3>
<p>UserController.php 负责调用模型并返回结果:</p>
```php
<?php
// controllers/UserController.php
require_once '../models/User.php';
class UserController {
private $user;
public function __construct() {
$this->user = new User();
}
public function getAll() {
return ['users' => $this->user->getAll()];
}
public function getById($id) {
return $this->user->getById($id);
}
public function create($data) {
if (empty($data['name']) || empty($data['email'])) {
http_response_code(400);
return ['error' => 'Name and email required'];
}
return $this->user->create($data);
}
public function update($id, $data) {
if (empty($data['name']) || empty($data['email'])) {
http_response_code(400);
return ['error' => 'Name and email required'];
}
return $this->user->update($id, $data);
}
public function delete($id) {
return $this->user->delete($id);
}
}
?>测试API接口
使用 curl 或 Postman 测试接口是否正常工作:
- 获取所有用户:GET http://localhost/api/users
- 获取单个用户:GET http://localhost/api/users/1
- 创建用户:POST http://localhost/api/users → body: {"name": "John", "email": "john@example.com"}
- 更新用户:PUT http://localhost/api/users/1 → body: {"name": "Jane", "email": "jane@example.com"}
- 删除用户:DELETE http://localhost/api/users/1
基本上就这些。这套结构清晰、可扩展性强。后续可以加入身份验证(如JWT)、输入验证、日志记录等功能来增强安全性与稳定性。不需要框架也能写出规范的RESTful API。
以上就是《PHP搭建RESTfulAPI教程详解》的详细内容,更多关于的资料请关注golang学习网公众号!
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
256 收藏
-
167 收藏
-
107 收藏
-
283 收藏
-
254 收藏
-
292 收藏
-
238 收藏
-
407 收藏
-
414 收藏
-
332 收藏
-
262 收藏
-
171 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习