随着移动、云计算、物联网等技术的快速发展,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格式的数据。二、搭建开发环境
在搭建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个路由:
/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服务器的详细内容。