如何使用PHP搭建API服务器-PHP问题-PHP中文网

如何使用PHP搭建API服务器

PHPz

发布： 2023-04-21 09:06:57

原创

2169人浏览过

随着移动、云计算、物联网等技术的快速发展，api成为了各种应用和系统之间数据交互的重要方式。在web开发领域，php作为一种流行的后端语言，其提供了很多便于实现api的库和框架。本文将介绍如何使用php搭建api服务器，分享从设计到实现的全过程。

一、需求分析和设计思路

在实现API服务器前，我们需要明确需求和设计思路。本文实现的是一个简单的API服务器，其需求可以概括为：

支持HTTP协议，能够处理GET、POST等请求；
能够解析URL参数，实现RESTful API；
能够返回JSON格式的数据；
支持OAuth2授权，保护API的安全性。

为了实现以上需求，我们可以考虑如下的设计思路：

使用PHP扩展包Slim或Lumen来搭建API服务器，它们提供了良好的路由、中间件、控制器等结构化编程工具和丰富的插件机制；
在路由中解析URL参数，使用OAuth2框架来保护API的安全性；
在控制器中获取请求参数，调用模型来访问数据库或其他数据源，输出JSON格式的数据。

二、搭建开发环境

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

在搭建API服务器前，我们需要准备好PHP、MySQL等必要的开发环境。可以选择使用集成开发环境（IDE）如PHPStorm、Eclipse等，也可以使用轻量级的编辑器如Visual Studio Code、Sublime Text等。本文以PHPStorm为例。

安装PHPStorm及PHP环境：下载PHPStorm，安装过程中会提示安装PHP环境，默认会安装PHP，也可以自己选择安装路径。安装完成后，运行PHPStorm，打开设置（Preferences），在Languages & Frameworks > PHP中添加PHP解释器。
安装MySQL：下载并安装MySQL，创建和配置数据库。
安装Composer：Composer是PHP的依赖管理器，可以大大简化PHP的开发工作。在命令行中执行以下命令安装Composer：

php -r "readfile('https://getcomposer.org/installer');" | php

登录后复制

安装完成后，将composer.phar移动到全局可用的路径，例如/usr/bin/composer。

三、搭建API服务器

有了上述开发环境，我们可以开始搭建API服务器。

创建项目：在PHPStorm中创建一个新的PHP项目，并使用Composer安装Slim或Lumen框架：

composer require slim/slim

登录后复制

或

composer require illuminate/routing illuminate/http

登录后复制

注意：如果选择使用Lumen框架，需要在bootstrap/app.php文件中打开$app->withFacades()和$app->withEloquent()开关，以便使用Lumen提供的Facade和Eloquent ORM功能。

创建路由：在Slim或Lumen框架中，创建路由和中间件是很容易的。在根目录下创建routes.php文件，例如：

$app->get('/hello/{name}', function ($request, $response, $args) {
    $name = $args['name'];
    $response->getBody()->write("Hello, $name");
    return $response;
});

$app->get('/users', 'UsersController:index');

$app->post('/users', 'UsersController:create');

登录后复制

这里定义了3个路由：

AppMall应用商店

AI应用商店，提供即时交付、按需付费的人工智能应用服务

查看详情

/hello/{name}：接受一个name参数，返回"Hello, name"的字符串；
/users：GET请求，调用UsersController的index方法，返回所有用户数据；
/users：POST请求，调用UsersController的create方法，创建一个新的用户记录。

创建中间件：在路由中加入中间件，可以实现一些预处理、过滤、授权等功能。在根目录下创建middleware.php文件，例如：

$app->add(new JwtAuthMiddleware());

登录后复制

这里定义了一个JwtAuthMiddleware中间件，用于验证OAuth2授权的token和权限。

创建控制器：在根目录下创建控制器文件，例如UsersController.php，以实现路由定义的所有方法。控制器的代码结构可以参考以下示例：

namespace App\Controllers;

use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use App\Models\User;

class UsersController {
    
    public function index(Request $request, Response $response) {
        $users = User::all();
        $response = $response->withJson($users);
        return $response;
    }
    
    public function create(Request $request, Response $response) {
        $data = $request->getParsedBody();
        $user = new User;
        $user->name = $data['name'];
        $user->email = $data['email'];
        $user->password = password_hash($data['password'], PASSWORD_DEFAULT);
        $user->save();
        $response = $response->withJson($user);
        return $response;
    }
    
}

登录后复制

这里定义了一个UsersController控制器，包含index和create方法，分别对应/users GET和/users POST请求。使用Eloquent ORM操作用户数据表（User::all()和$user->save()），返回JSON格式的响应。

运行API服务器：在命令行中进入项目目录，执行以下命令：

php -S localhost:8000 -t public

登录后复制

这里启动了一个PHP的内置Web服务器，监听8000端口。在浏览器中访问http://localhost:8000/hello/world，正常情况下应该返回"Hello, world"字符串。访问http://localhost:8000/users时，应该返回所有用户的JSON格式数据。

四、OAuth2授权

默认情况下，API服务器是不安全的，因为任何人都可以访问接口并修改数据。为了保护API，我们可以使用OAuth2授权。OAuth2是一个标准的授权协议，可以在不泄露用户名和密码的情况下，授权第三方应用访问特定用户在某个资源服务器上的受保护资源。在本文中，我们使用Firebase的JWT框架来实现OAuth2授权。

安装Firebase JWT框架：使用Composer安装Firebase JWT框架：

composer require firebase/php-jwt

登录后复制

创建授权服务器：在根目录下创建AuthorizationServer.php文件，例如：

namespace App;

use Firebase\JWT\JWT;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use App\Models\User;

class AuthorizationServer {
    
    private static $key = 'your_secret_key';
    
    public static function getToken(Request $request, Response $response) {
        $data = $request->getParsedBody();
        $user = User::where('email', $data['email'])->first();
        if (!$user || !password_verify($data['password'], $user->password)) {
            return $response->withStatus(401)->withJson([
                'error' => 'Invalid email or password.'
            ]);
        }
        $now = time();
        $payload = array(
            'iat' => $now,
            'exp' => $now + 3600,
            'sub' => $user->id
        );
        $jwt = JWT::encode($payload, self::$key);
        
        return $response->withJson([
            'access_token' => $jwt,
            'token_type' => 'Bearer',
            'expires_in' => 3600
        ]);
    }
    
    public static function authenticate(Request $request) {
        $jwt = isset($request->getHeader('Authorization')[0]) ? explode(' ', $request->getHeader('Authorization')[0])[1] : null;
        if (!$jwt) {
            throw new Exception('Unauthorized.');
        }
        try {
            $decoded = JWT::decode($jwt, self::$key, array('HS256'));
            $user = User::find($decoded->sub);
            if (!$user) {
                throw new Exception('Unauthorized.');
            }
            return $user;
        } catch (Exception $e) {
            throw new Exception('Unauthorized.');
        }
    }
    
}

登录后复制

这里定义了一个AuthorizationServer授权服务器，包含两个方法：

getToken：接受客户端传递的email和password，生成access token并返回给客户端；
authenticate：接受客户端传递的access token，验证并返回用户对象。

这里使用了JWT加密框架，将用户信息存储在token中，并使用HS256算法加密。

创建中间件：在根目录下创建中间件文件JwtAuthMiddleware.php，例如：

namespace App\Middlewares;

use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use App\AuthorizationServer;

class JwtAuthMiddleware {
    
    public function __invoke(Request $request, Response $response, $next) {
        try {
            $user = AuthorizationServer::authenticate($request);
            $request = $request->withAttribute('user', $user);
            return $next($request, $response);
        } catch (Exception $e) {
            return $response->withStatus(401)->withJson([
                'error' => $e->getMessage()
            ]);
        }
    }
    
}

登录后复制

这里定义了一个JwtAuthMiddleware中间件，用户验证客户端请求的access token的有效性，并在后面的控制器中通过$request->getAttribute('user')获取到用户对象。

更新路由：在路由中加入OAuth2授权相关的路由和中间件。在routes.php文件中增加以下代码：

$app->post('/auth/token', 'AuthorizationServer:getToken');

$app->group('', function () use ($app) {
    $app->get('/users/@id', 'UsersController:getUser');
    $app->put('/users/@id', 'UsersController:updateUser');
    $app->delete('/users/@id', 'UsersController:deleteUser');
})->add(new JwtAuthMiddleware());

登录后复制

这里定义了一个/auth/token路由，用于获取访问令牌。另外，对于需要OAuth2授权的路由（getUser、updateUser和deleteUser），使用$app->group()方法包裹其中，并添加JwtAuthMiddleware中间件。

五、总结

本文介绍了如何使用PHP搭建API服务器，基于Slim或Lumen框架，解析URL参数、返回JSON格式的数据，并使用OAuth2框架保护API的安全性。使用这种方式搭建API服务器，可以快速、高效地开发出各种类型的RESTful API。但是，具体实现还需要根据实际需求进行适当调整和优化。

以上就是如何使用PHP搭建API服务器的详细内容，更多请关注php中文网其它相关文章！