모바일, 클라우드 컴퓨팅, 사물 인터넷 및 기타 기술의 급속한 발전으로 API는 다양한 애플리케이션과 시스템 간의 데이터 상호 작용을 위한 중요한 방법이 되었습니다. 웹 개발 분야에서 널리 사용되는 백엔드 언어인 PHP는 API 구현을 용이하게 하는 많은 라이브러리와 프레임워크를 제공합니다. 이 기사에서는 PHP를 사용하여 API 서버를 구축하는 방법을 소개하고 설계부터 구현까지 전체 프로세스를 공유합니다.
1. 요구사항 분석 및 디자인 아이디어
API 서버를 구현하기 전에 요구사항과 디자인 아이디어를 명확히 해야 합니다. 이 문서에서는 간단한 API 서버를 구현하며 해당 요구 사항을 다음과 같이 요약할 수 있습니다.
위 요구 사항을 달성하기 위해 다음과 같은 디자인 아이디어를 고려할 수 있습니다.
2. 개발 환경 구축
API 서버 구축에 앞서 PHP, MySQL 등 필요한 개발 환경을 준비해야 합니다. PHPStorm, Eclipse 등과 같은 통합 개발 환경(IDE)을 사용하도록 선택하거나 Visual Studio Code, Sublime Text 등과 같은 경량 편집기를 사용할 수 있습니다. 이 문서에서는 PHPStorm을 예로 들어 설명합니다.
php -r "readfile('https://getcomposer.org/installer');" | php설치가 완료된 후 작곡가.phar를 전역적으로 사용 가능한 경로(예: /usr/bin/composer)로 이동합니다.
3. API 서버 구축
위의 개발 환경에서 API 서버 구축을 시작할 수 있습니다.
composer require slim/slim
또는
composer require illuminate/routing illuminate/http
참고: Lumen 프레임워크를 사용하도록 선택한 경우 bootstrap/app.php 파일 $app->withFacades() 및 $app->withEloquent() 스위치를 켜면 Lumen에서 제공하는 Facade 및 Eloquent ORM 기능을 사용할 수 있습니다.
$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');여기에는 세 개의 경로가 정의되어 있습니다:
$app->add(new JwtAuthMiddleware());
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;
}
}php -S localhost:8000 -t public
4. OAuth2 인증
기본적으로 API 서버는 누구나 인터페이스에 액세스하고 데이터를 수정할 수 있으므로 안전하지 않습니다. API를 보호하기 위해 OAuth2 인증을 사용할 수 있습니다. OAuth2는 사용자 이름과 비밀번호를 공개하지 않고 리소스 서버에 있는 특정 사용자의 보호된 리소스에 액세스할 수 있도록 타사 애플리케이션에 권한을 부여할 수 있는 표준 인증 프로토콜입니다. 이 문서에서는 Firebase의 JWT 프레임워크를 사용하여 OAuth2 인증을 구현합니다.
Firebase JWT 프레임워크 설치: Composer를 사용하여 Firebase JWT 프레임워크 설치:composer require firebase/php-jwt
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.');
}
}
}这里使用了JWT加密框架，将用户信息存储在token中，并使用HS256算法加密。
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')获取到用户对象。
$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 중국어 웹사이트의 기타 관련 기사를 참조하세요!
![[웹 프런트엔드] Node.js 빠른 시작](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
