从零开始构建PHP RESTful API｜完整示例与前端调用实践

一. 概述

应用程序接口（API） 是一组指令、协议或工具，用于在客户端应用程序中访问数据或功能，同时也能在数据库应用中安全地传输数据。它通过控制数据流，限制客户端对主数据的完全控制，从而保护数据库免受潜在攻击。

在本文中，我们将通过 PHP 创建一个简单的 RESTful API。

RESTful API 的核心概念是：从数据库中提取数据，并通过 Web API 提供给客户端应用程序，例如网站或桌面应用。

本教程使用一个数据数组模拟数据库，并通过 REST API 返回数据，而不是直接连接服务器上的真实数据库。前端部分我们使用 Ajax 与 JavaScript Fetch API 获取数据。

项目文件结构：

Database.php：包含模拟数据库的数据数组。
myWebAPI.php：实现 Web API 的文件。
Consumer.html：客户端应用，用于调用 API。

在本演示中，我们将使用 Laragon 作为本地开发环境。你也可以选择 Apache 或其他本地服务器。

二. 创建 Database.php

首先，创建一个 Database.php 文件，用于模拟数据库。我们用一个数组存储数据，当传入参数 1 时，将返回 ASP.Net。

示例代码：

<?php
$data = [
    1 => "ASP.Net",
    2 => "PHP",
    3 => "JavaScript"
];

if (isset($_GET['number'])) {
    $number = $_GET['number'];
    echo isset($data[$number]) ? $data[$number] : "数据不存在";
}
?>

这样，我们就完成了最基础的“数据提供”逻辑。

三. 创建 Web API 文件

接着，创建 myWebAPI.php，并在其中实现一个简单的 GET API 方法。

代码示例：

<?php
include "Database.php";

header("Content-Type: application/json; charset=UTF-8");

$response = null;

if (isset($_GET['number'])) {
    $number = $_GET['number'];
    $response = isset($data[$number]) ? $data[$number] : "数据不存在";
}

echo json_encode(["response" => $response]);
?>

注意：Database.php 与 myWebAPI.php 必须放在同一目录下。

四. 创建 Consumer.html

然后，创建一个 Consumer.html 文件，在前端调用 API。

示例代码：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
  <title>Web API 消费者</title>
</head>
<body>
  <h1>调用 RESTful API 示例</h1>
  <button id="fetchData">获取数据</button>
  <div id="result"></div>

  <script>
    document.getElementById('fetchData').addEventListener('click', function() {
      fetch('http://localhost:8080/myWebAPI.php?number=1')
        .then(response => response.json())
        .then(data => {
          document.getElementById('result').innerText = data.response;
        })
        .catch(error => console.error('Error:', error));
    });
  </script>
</body>
</html>

点击按钮后，将调用 PHP RESTful API 并在页面中显示返回结果。

五. 运行 Laragon 并测试应用

测试步骤如下：

启动 Laragon 或其他本地开发服务器。
将 Database.php、myWebAPI.php 和 Consumer.html 放入服务器根目录。
在 Laragon 中点击“全部启动”以运行 Apache。
打开浏览器并访问 Consumer.html 文件。
点击“获取数据”按钮，即可测试 API 功能。

API 示例访问地址：

http://localhost:8080/myWebAPI.php?number=1

参数说明

number：传递给 API 的参数，用于从数组中获取对应数据。
jsonCallback（可选）：支持返回 JSON 数据。

六. 总结

本文完整演示了如何：

使用 PHP 创建一个简单的 RESTful API
在前端使用 Fetch API 调用 PHP Web API
通过 Laragon 本地环境运行和测试

本教程重点展示了 GET 方法 的实现，并为初学者提供了清晰的上手路径。

如果你希望进一步提升，可以尝试使用 Laravel、Symfony 等框架，构建更复杂和可扩展的 RESTful API 服务。

继续编码吧！ 🚀

原文链接: https://www.freecodespot.com/blog/php-rest-api/