开发php接口需遵循明确步骤与规范，首先确定需求并设计restful风格的URL，如/api/v1/users，使用小写和复数形式；接着定义请求方法，优先支持jsON格式传输；通过$_GET或$_POST获取参数，并进行安全过滤；业务逻辑中连接数据库处理数据，如用mysqli查询用户列表；返回统一json结构包含code、msg和data字段，如成功时code为200；同时设置合理状态码，防范SQL注入与xss攻击，关键操作加入Token验证；最后用postman或curl测试接口。示例代码展示了获取用户列表的过程，确保响应头为application/json，仅允许GET请求，查询结果限10条并正确关闭连接，实现了一个安全、规范的基础API接口。

写一个PHP接口其实不难，关键是要结构清晰、数据规范、安全可靠。下面从步骤、开发规范到代码实例一步步讲清楚，适合新手上手和团队协作参考。

一、PHP接口开发的基本步骤

开发一个可用的API接口，通常按以下流程进行：

• 明确需求：确定接口功能，比如用户登录、获取文章列表等。
• 设计接口URL：使用RESTful风格，如 /api/users 获取用户列表。
• 定义请求方式：GET（查）、POST（增）、PUT（改）、delete（删）。
• 处理参数：从 $_GET、$_POST 或 JSON 输入中获取数据。
• 业务逻辑处理：连接数据库、验证、计算等。
• 返回JSON格式数据：统一输出格式，便于前端解析。
• 测试与调试：用 Postman 或 curl 测试接口是否正常。

二、接口开发规范建议

为了让接口更稳定、易维护，遵守一些通用规范很重要。

1. URL设计规范

• 使用小写字母和短横线或斜杠分隔，避免大写和下划线。
• 推荐使用版本号，如 /api/v1/users，方便后续升级。
• 资源名用复数，如 /users 而不是 /user。

2. 请求与响应格式

• 请求数据优先支持JSON格式，设置Content-Type: application/json。
• 响应统一使用JSON，包含状态码、提示信息和数据体。
• 示例响应结构：

   {   "code": 200,   "msg": "操作成功",   "data": {     "id": 1,     "name": "张三"   } } 

3. 状态码定义

• 200：成功
• 400：参数错误
• 401：未授权
• 404：接口不存在
• 500：服务器内部错误

4. 安全考虑

• 过滤输入参数，防止SQL注入和XSS攻击。
• 敏感操作加Token验证（如JWT）。
• 限制接口访问频率，防刷。

三、代码实例：用户列表接口

下面是一个简单的“获取用户列表”接口示例，使用原生PHP + mysqli。

立即学习“PHP免费学习笔记（深入）”；

开拍

用AI制作口播视频

158

查看详情

 <?php // 设置响应头为JSON header('Content-Type: application/json; charset=utf-8');  // 模拟数据库连接 $host = 'localhost'; $user = 'root'; $pass = ''; $db   = 'test_db';  $conn = new mysqli($host, $user, $pass, $db); if ($conn->connect_error) {     echo json_encode([         'code' => 500,         'msg'  => '数据库连接失败',         'data' => null     ]);     exit; }  // 只允许GET请求 if ($_SERVER['REQUEST_METHOD'] !== 'GET') {     http_response_code(405);     echo json_encode([         'code' => 405,         'msg'  => '请求方法不被允许',         'data' => null     ]);     exit; }  // 查询用户数据 $sql = "SELECT id, name, email FROM users LIMIT 10"; $result = $conn->query($sql);  $users = []; if ($result->num_rows > 0) {     while ($row = $result->fetch_assoc()) {         $users[] = $row;     } }  // 返回成功响应 echo json_encode([     'code' => 200,     'msg'  => '获取成功',     'data' => $users ]);  $conn->close(); 

四、如何测试这个接口

保存为 get_users.php，放在Web目录下，通过浏览器或工具访问：

• 地址：http://localhost/api/v1/get_users.php
• 工具推荐：Postman、curl、Apifox
• curl 示例：

   curl -X GET http://localhost/api/v1/get_users.php 

基本上就这些。只要按规范写，哪怕用原生PHP也能做出清晰可靠的接口。后期可以封装成类或使用框架（如laravel、thinkphp）提升效率。