PHP를 사용하여 API 서버를 구축하는 방법

모바일, 클라우드 컴퓨팅, 사물 인터넷 및 기타 기술의 급속한 발전으로 API는 다양한 애플리케이션과 시스템 간의 데이터 상호 작용을 위한 중요한 방법이 되었습니다. 웹 개발 분야에서 널리 사용되는 백엔드 언어인 PHP는 API 구현을 용이하게 하는 많은 라이브러리와 프레임워크를 제공합니다. 이 기사에서는 PHP를 사용하여 API 서버를 구축하는 방법을 소개하고 설계부터 구현까지 전체 프로세스를 공유합니다.

1. 요구사항 분석 및 디자인 아이디어

API 서버를 구현하기 전에 요구사항과 디자인 아이디어를 명확히 해야 합니다. 이 문서에서는 간단한 API 서버를 구현하며 해당 요구 사항을 다음과 같이 요약할 수 있습니다.

1. 는 HTTP 프로토콜을 지원하고 GET, POST 및 기타 요청을 처리할 수 있습니다.
2. 는 URL 매개변수를 구문 분석하고
3. 에서 데이터를 반환할 수 있습니다. JSON 형식 ;
4. API 보안을 보호하기 위해 OAuth2 인증을 지원합니다.

위 요구 사항을 달성하기 위해 다음과 같은 디자인 아이디어를 고려할 수 있습니다.

1. PHP 확장 패키지 Slim 또는 Lumen을 사용하여 API 서버를 구축합니다. 이 패키지는 우수한 라우팅, 미들웨어, 컨트롤러 및 기타 구조화된 프로그래밍 도구를 제공합니다. 풍부한 플러그인 메커니즘;
2. 경로의 URL 매개변수를 구문 분석하고 OAuth2 프레임워크를 사용하여 API 보안을 보호합니다.
3. 컨트롤러에서 요청 매개변수를 가져오고, 모델을 호출하여 데이터베이스 또는 기타 데이터 소스에 액세스하고, 데이터를 JSON 형식으로 출력합니다. .

2. 개발 환경 구축

API 서버 구축에 앞서 PHP, MySQL 등 필요한 개발 환경을 준비해야 합니다. PHPStorm, Eclipse 등과 같은 통합 개발 환경(IDE)을 사용하도록 선택하거나 Visual Studio Code, Sublime Text 등과 같은 경량 편집기를 사용할 수 있습니다. 이 문서에서는 PHPStorm을 예로 들어 설명합니다.

1. PHSPtorm 및 PHP 환경 설치: PHPStorm을 다운로드하면 설치 과정에서 PHP 환경을 설치하라는 메시지가 표시됩니다. PHP는 기본적으로 설치되거나 설치 경로를 직접 선택할 수 있습니다. 설치가 완료되면 PHPStorm을 실행하고 기본 설정을 열고 언어 및 프레임워크 > PHP에서 PHP 인터프리터를 추가하세요.
2. MySQL 설치: MySQL을 다운로드 및 설치하고 데이터베이스를 생성 및 구성합니다.
3. Install Composer: Composer는 PHP 개발 작업을 크게 단순화할 수 있는 PHP용 종속성 관리자입니다. Composer를 설치하려면 명령줄에서 다음 명령을 실행하세요.

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

설치가 완료된 후 작곡가.phar를 전역적으로 사용 가능한 경로(예: /usr/bin/composer)로 이동합니다.

3. API 서버 구축

위의 개발 환경에서 API 서버 구축을 시작할 수 있습니다.

1. 프로젝트 생성: 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 기능을 사용할 수 있습니다.

2. 경로 만들기: 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');

여기에는 세 개의 경로가 정의되어 있습니다:

• /hello/{name}: name 매개변수를 허용하고 "Hello, name" 문자열을 반환합니다. /users: GET 요청, UsersController의 인덱스 메소드 호출, 모든 사용자 데이터 반환
• /users: POST 요청, UsersController의 생성 메소드 호출, 새 사용자 레코드 생성.

미들웨어 생성: 라우팅에 미들웨어를 추가하면 일부 전처리, 필터링, 인증 및 기타 기능을 구현할 수 있습니다. 루트 디렉터리에 middleware.php 파일을 만듭니다. 예:

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

A JwtAuthMiddleware 미들웨어는 OAuth2에서 승인한 토큰과 권한을 확인하기 위해 여기에 정의됩니다.

컨트롤러 생성: 경로에 의해 정의된 모든 메서드를 구현하려면 루트 디렉터리에 UsersController.php와 같은 컨트롤러 파일을 생성합니다. 컨트롤러의 코드 구조는 다음 예를 참조할 수 있습니다.

4. 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;
       }
       
   }

각각 /users GET 및 /users POST 요청에 해당하는 index 및 create 메서드를 포함하여 UsersController 컨트롤러가 여기에 정의됩니다. Eloquent ORM을 사용하여 사용자 데이터 테이블(User::all() 및 $user->save())을 작동하고 JSON 형식으로 응답을 반환합니다.

API 서버 실행: 명령줄에 프로젝트 디렉터리를 입력하고 다음 명령을 실행합니다.

5. php -S localhost:8000 -t public

내장된 PHP 웹 서버가 여기에서 시작되어 포트 8000에서 수신 대기합니다. 브라우저에서 http://localhost:8000/hello/world에 액세스합니다. 일반적인 상황에서는 "Hello, world" 문자열이 반환되어야 합니다. http://localhost:8000/users에 접속하면 모든 사용자의 JSON 형식의 데이터가 반환되어야 합니다.

4. OAuth2 인증

기본적으로 API 서버는 누구나 인터페이스에 액세스하고 데이터를 수정할 수 있으므로 안전하지 않습니다. API를 보호하기 위해 OAuth2 인증을 사용할 수 있습니다. OAuth2는 사용자 이름과 비밀번호를 공개하지 않고 리소스 서버에 있는 특정 사용자의 보호된 리소스에 액세스할 수 있도록 타사 애플리케이션에 권한을 부여할 수 있는 표준 인증 프로토콜입니다. 이 문서에서는 Firebase의 JWT 프레임워크를 사용하여 OAuth2 인증을 구현합니다.

Firebase JWT 프레임워크 설치: Composer를 사용하여 Firebase JWT 프레임워크 설치:

1. composer require firebase/php-jwt

인증 서버 생성: 루트 디렉터리에 AuthorizationServer.php 파일을 생성합니다. 예:

2. 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算法加密。

3. 创建中间件：在根目录下创建中间件文件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')获取到用户对象。

4. 更新路由：在路由中加入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 중국어 웹사이트의 기타 관련 기사를 참조하세요!