零基础掌握 PHP REST API 开发：从项目结构到完整接口实现指南

一. 为什么要构建 REST API

PHP 是一种功能强大的服务器端编程语言，广泛应用于处理 HTTP 请求、用户身份验证、数据库交互等任务。而 REST API 则为两个应用程序之间提供了一个标准化的通信接口。

构建 REST API 的主要原因是它可以让不同的应用程序通过 HTTP 协议进行交互，从而实现数据共享和功能扩展。对于初学者来说，这也是进入 后端开发 的必备技能之一。

二. 术语表

在构建 PHP REST API 的过程中，我们会遇到一些常见的技术术语。以下是对这些术语的简要解释：

1. 基础术语

REST：全称 Representational State Transfer（表现性状态转移），是一种基于 HTTP 协议的架构风格。
API：全称 Application Programming Interface（应用程序编程接口），是一个软件中介，允许两个应用程序之间进行通信。
HTTP 动词：如 GET、POST、PUT、PATCH，用于不同类型的请求。
端点（Endpoint）：API 与其他系统交互的接触点，通常是一个 URL，用于访问特定资源。
中间件（Middleware）：在请求与响应之间进行处理的逻辑，常用于验证、鉴权等操作。

三. 项目要求

1. 环境与工具

本地主机服务器：推荐使用 XAMPP、LAMPP、MAMPP 或 AMPPS。
Composer：PHP 的包管理器，用于安装依赖（Composer 官网）。
Git：建议安装，用于代码版本管理。
PHP：确保已正确安装并具备基础知识。
Postman：测试和消费 API 的工具。
文本编辑器：推荐 Visual Studio Code 或 Atom。
耐心与决心：构建 REST API 需要细致的实践。

四. 项目目录结构

1. 基础目录

/PHP-REST-API

    /App        # 应用程序逻辑

    /public     # 公共目录

    composer.json

    index.php   # 项目入口文件

2. 安装依赖

在根目录中编辑 composer.json 文件后运行：

composer install

这将安装所需外部包（如 Klein 和 Firebase JWT），并生成 composer.lock 与 vendor 文件夹。

五. 项目实现步骤

1. 编辑 Index.php 文件

index.php 是应用程序的入口文件，主要用于加载依赖和定义路由：

<?php
require_once __DIR__ . '/vendor/autoload.php';

$klein = new \Klein\Klein();

// 定义路由
$klein->respond('GET', '/', function () {
    return 'Hello, REST API!';
});

$klein->dispatch();

2. 创建端点（routes 目录）

在 App/routes/api.php 中定义 REST API 端点：

<?php
$klein->respond('GET', '/api/v1/resource', function () {
    return json_encode(['message' => 'Resource fetched successfully']);
});

3. 启动基础模型（Model 目录）

在 App/Model/Model.php 中定义基础数据库连接类：

<?php
namespace App\Model;

use PDO;

class Model {
    protected $db;

    public function __construct() {
        $this->db = new PDO('mysql:host=localhost;dbname=test', 'root', '');
    }
}

4. 创建用户模型（UserModel）

在 App/Model/UserModel.php 文件中实现用户相关 CRUD：

<?php
namespace App\Model;

class UserModel extends Model {
    public function createUser($data) {
        $stmt = $this->db->prepare("INSERT INTO users (name, email) VALUES (:name, :email)");
        $stmt->execute($data);
        return $stmt->rowCount() > 0;
    }
}

5. 创建中间件（Middleware 目录）

在 App/Middleware/RequestMiddleware.php 中验证请求：

<?php
namespace App\Middleware;

class RequestMiddleware {
    public static function validate($request) {
        // 验证逻辑
        return true;
    }
}

6. 创建控制器（Controller 目录）

在 App/Controller/UserController.php 文件中编写业务逻辑：

<?php
namespace App\Controller;

use App\Model\UserModel;

class UserController {
    public function createNewUser($request) {
        $userModel = new UserModel();
        $data = $request->paramsPost();
        return $userModel->createUser($data);
    }
}