如何使用PHP编写RESTful API方法-猿码集

使用PHP编写RESTful API方法

1. 什么是RESTful API

REST（Representational State Transfer）是一种基于HTTP协议实现的Web服务架构风格，它主要通过HTTP协议中的GET、POST、PUT、DELETE等方法来实现对资源（Resource）的操作和管理。而RESTful API就是一个符合REST架构风格的Web API。

RESTful API的特点包括：使用URL定位资源，使用HTTP方法操作资源，常规数据格式（JSON、XML等），无状态性。它的优点在于能够使得Web API的设计底层更加简单、灵活、可扩展以及易于维护。

2. 如何使用PHP编写RESTful API

使用PHP编写RESTful API需要一个HTTP服务器、PHP解释器和一个路由处理类。在此我们使用Apache服务器、PHP 7.0+和Slim路由处理类作为实例进行说明。

2.1 搭建环境

首先需要在本地搭建一个Apache服务器，并配置好PHP解释器。接着需要安装Slim路由处理类。

在终端中输入以下命令来安装Slim：

composer require slim/slim "^4.0"

我们需要建立一个.php文件，这个文件将用于处理请求和输出响应，以下是PHP代码：


require __DIR__ . '/../vendor/autoload.php';
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
$app = new \Slim\App();
$app->get('/hello/{name}', function (Request $request, Response $response, array $args) {
    $name = $args['name'];
    $response->getBody()->write("Hello, $name");
    return $response;
});
$app->run();

在这个例子中，我们为路径/hello/{name}绑定了GET方法，并且参数{name}会自动赋值为URL中对应的参数值。

2.2 响应格式

对于RESTful API的响应格式，通常使用JSON或XML格式。以下是一个使用JSON格式的响应示例：


$response = new \stdClass();
$response->id = 1;
$response->name = 'foo';
$response->age = 20;
return $response;

如果你需要在响应体里同时返回多个结果，需将其封装成数组或对象，以下是一个返回多个结果的响应示例：


$response = new \stdClass();
$response->meta = array('count'=>2);
$response->data = array(
    array('id'=>1, 'name'=>'foo', 'age'=>20),
    array('id'=>2, 'name'=>'bar', 'age'=>25)
);
return $response;

2.3 路由

在RESTful API中，路由是指将请求匹配到相应资源（Resource）或方法（Method）的过程。Slim框架内置了路由解析器，使用$httpMethod和$pattern等参数来匹配请求。

以下是一个路由的基本实例：


$app->get('/users/{id}', function (Request $request, Response $response, array $args) {
    $id = $args['id'];
    // 这里是处理请求的代码逻辑
    return $response;
});

以上代码表示匹配GET请求方法且路径为/users/{id}的请求。当有这样的请求时，Slim路由解析器会依次比对每个路由，直到匹配到符合的路由。

3. 实践案例

下面我们使用一个简单的实例来说明如何使用Slim路由去解决一个RESTful API，这个实例的功能就是读取、创建、更新、删除（CRUD）用户。

为了标准化请求和响应，我们使用JSON格式：

3.1 GET请求

GET请求用于获取资源：


$app->get('/users/{id}', function (Request $request, Response $response, array $args) {
    $id = $args['id'];
    // 查询对应id的用户
    $user = queryUserById($id);
    if(!$user) {
        return $response->withStatus(404)->withJson(array('status'=>'error', 'message'=>'User not found'));
    }
    return $response->withJson(array('status'=>'success', 'user'=>$user));
});

3.2 POST请求

POST请求用于创建资源：


$app->post('/users', function (Request $request, Response $response, array $args) {
    $body =  $request->getParsedBody();
    if(empty($body['name'])) {
        return $response->withStatus(400)->withJson(array('status'=>'error', 'message'=>'Name cannot be empty'));
    }
    $user = array('name'=>$body['name'], 'age'=>isset($body['age'])?$body['age']:18);
    $id = createUser($user);
    $user['id'] = $id;
    return $response->withJson(array('status'=>'success', 'user'=>$user));
});

3.3 PUT请求

PUT请求用于更新资源：


$app->put('/users/{id}', function (Request $request, Response $response, array $args) {
    $id = $args['id'];
    // 查询对应id的用户
    $user = queryUserById($id);
    if(!$user) {
        return $response->withStatus(404)->withJson(array('status'=>'error', 'message'=>'User not found'));
    }
    $body =  $request->getParsedBody();
    if(isset($body['name'])) {
        $user['name'] = $body['name'];
    }
    if(isset($body['age'])) {
        $user['age'] = $body['age'];
    }
    updateUser($id, $user);
    return $response->withJson(array('status'=>'success', 'user'=>$user));
});

3.4 DELETE请求

DELETE请求用于删除资源：


$app->delete('/users/{id}', function (Request $request, Response $response, array $args) {
    $id = $args['id'];
    $user = queryUserById($id);
    if(!$user) {
        return $response->withStatus(404)->withJson(array('status'=>'error', 'message'=>'User not found'));
    }
    deleteUser($id);
    return $response->withJson(array('status'=>'success', 'message'=>'User has been deleted'));
});

4. 总结

RESTful API是Web开发中不可缺少的环节，而使用PHP开发RESTful API是一个非常方便的方式。使用Slim框架能够使PHP开发者更加方便地搭建RESTful API，并能够使得API的设计更加符合REST架构风格。

如何使用PHP编写RESTful API方法