php怎么编写接口_php开发api接口的规范与实例

编写PHP接口需遵循HTTP方法规范、统一JSON返回格式（code、msg、data）、合理使用状态码，并采用RESTful风格URL。示例展示通过GET请求查询用户信息，结合参数校验与路由处理，返回标准化数据；实际开发中应增加Token验证、输入过滤、日志记录及CORS支持以提升安全性，并封装通用响应函数提高复用性，最终构建稳定、可维护的API服务。

编写PHP接口（API）是现代Web开发中的常见需求，尤其在前后端分离、移动端对接等场景中尤为重要。一个规范、安全、易维护的API能极大提升项目协作效率和系统稳定性。下面从规范到实例，详细介绍如何用PHP开发API接口。

一、PHP开发API接口的基本规范

遵循统一规范有助于团队协作和后期维护：

• 使用标准HTTP方法：GET（获取）、POST（创建）、PUT（更新）、DELETE（删除）应与操作语义一致。
• 统一返回格式：建议采用JSON格式，包含code、msg、data三个基本字段。
• 状态码合理使用：如200表示成功，400表示请求错误，401表示未授权，500表示服务器错误。
• URL命名规范：使用小写字母、连字符或下划线分隔，推荐RESTful风格，例如：/api/users、/api/users/1。
• 参数校验：对所有输入参数进行合法性检查，防止SQL注入、XSS等安全问题。
• 接口文档清晰：可使用Swagger、Postman等工具生成文档，便于前端调用。

二、基础接口结构示例

以下是一个简单的用户信息查询接口，展示基本结构和返回格式：

<?php
// 设置响应头为JSON
header('Content-Type: application/json; charset=utf-8');

// 模拟数据库数据
$users = [
    1 => ['id' => 1, 'name' => '张三', 'email' => 'zhangsan@example.com'],
    2 => ['id' => 2, 'name' => '李四', 'email' => 'lisi@example.com']
];

// 获取请求方法和参数
$method = $_SERVER['REQUEST_METHOD'];
$id = isset($_GET['id']) ? (int)$_GET['id'] : null;

// 路由处理
if ($method === 'GET') {
    if ($id) {
        if (isset($users[$id])) {
            $response = ['code' => 200, 'msg' => 'success', 'data' => $users[$id]];
        } else {
            $response = ['code' => 404, 'msg' => '用户不存在', 'data' => null];
        }
    } else {
        $response = ['code' => 200, 'msg' => 'success', 'data' => array_values($users)];
    }
} else {
    $response = ['code' => 405, 'msg' => '请求方法不支持', 'data' => null];
}

// 输出JSON
echo json_encode($response, JSON_UNESCAPED_UNICODE);
?>

三、增加安全性与校验

真实项目中需加入更多防护措施：

绘蛙

电商场景的AI创作平台，无需高薪聘请商拍和文案团队，使用绘蛙即可低成本、批量创作优质的商拍图、种草文案

下载

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

• 防止非法访问：可通过Token验证，例如JWT或简单API Key。
• 过滤输入：使用filter_input或htmlspecialchars处理用户输入。
• 日志记录：记录异常请求，便于排查问题。
• 跨域支持（CORS）：若前端在不同域名下调用，需添加跨域头：

header("Access-Control-Allow-Origin: *");
header("Access-Control-Allow-Methods: GET, POST, PUT, DELETE");
header("Access-Control-Allow-Headers: Content-Type, Authorization");

四、封装通用响应函数

提高代码复用性，可封装统一返回方法：

function response($code, $msg, $data = null) {
    header('Content-Type: application/json; charset=utf-8');
    echo json_encode(['code' => $code, 'msg' => $msg, 'data' => $data], JSON_UNESCAPED_UNICODE);
    exit;
}

// 使用示例
if (!isset($_GET['id'])) {
    response(400, '缺少用户ID');
}