PHP RESTful API开发教程

1、遵循RESTful架构原则，使用标准HTTP方法操作资源，确保端点明确并返回合适状态码；2、通过.htaccess配置URL重写，实现简洁路径访问；3、在PHP中解析请求方法与路径，结合路由数组分发到对应处理函数；4、利用php://input读取JSON数据，配合json_decode和json_encode实现数据解析与响应；5、为用户等资源构建完整的CRUD接口，映射GET、POST、PUT、DELETE到具体操作；6、统一错误处理，根据场景返回404、405或500等状态码及错误信息。

如果您正在开发一个基于PHP的RESTful API，但不确定如何正确设计和实现接口，可能会遇到路由处理不当、数据格式不统一或HTTP状态码使用错误的问题。以下是构建PHP RESTful API的关键步骤和方法：

一、理解RESTful架构原则

RESTful API基于HTTP协议，使用标准的HTTP动词（如GET、POST、PUT、DELETE）来操作资源。每个URL代表一种资源，通过不同的请求方法执行相应操作。

1、确保每个端点对应一个明确的资源，例如 /users 表示用户集合。

2、使用HTTP方法映射CRUD操作：GET用于获取资源，POST用于创建资源，PUT用于更新资源，DELETE用于删除资源。

3、返回合适的状态码，例如成功获取资源时返回 200 OK，创建成功返回 201 Created。

二、配置URL重写以支持干净路径

为了让API使用简洁的URL结构（如 /api/users/1），需要启用Apache的mod_rewrite模块并配置.htaccess文件。

1、在项目根目录创建或编辑 .htaccess 文件，添加以下规则：

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php?url=$1 [QSA,L]

2、在PHP中通过 $_GET['url'] 获取原始请求路径，并据此分发请求。

三、实现请求方法识别与路由分发

通过解析请求的HTTP方法和路径，将请求转发到对应的处理函数。

1、使用 $_SERVER['REQUEST_METHOD'] 获取当前请求类型。

2、定义一个路由数组，将路径和方法组合映射到具体处理函数，例如：

$routes = [
'GET:/users' => 'getUsers',
'POST:/users' => 'createUser'
];

3、根据当前请求查找匹配的回调函数并执行。

四、处理JSON数据输入与输出

RESTful API通常使用JSON格式进行数据交换，需正确读取请求体并设置响应头。

1、使用 file_get_contents('php://input') 读取POST或PUT请求中的JSON数据。

2、调用 json_decode() 将JSON字符串转换为PHP数组。

3、在输出前设置头部信息：header('Content-Type: application/json')。

4、使用 json_encode() 将PHP数组编码为JSON格式并输出。

五、实现资源的增删改查接口

针对单一资源（如用户）提供完整的CRUD接口支持。

1、GET /users：调用 getAllUsers() 函数查询所有用户数据。

2、GET /users/1：调用 getUserById($id) 获取指定ID的用户。

3、POST /users：接收JSON格式的用户数据并插入数据库。

4、PUT /users/1：更新ID为1的用户信息，注意验证ID一致性。

5、DELETE /users/1：从数据库中删除指定用户记录。

六、添加错误处理与状态响应

当请求出现异常时，应返回适当的HTTP状态码和错误描述。

1、资源未找到时发送 http_response_code(404) 并返回错误信息。

2、对于非法请求方法，返回 405 Method Not Allowed 状态码。

3、服务器内部错误应捕获异常并返回 500 Internal Server Error。