Web API 在 PHP 中返回 JSON 示例

在开发 Web 应用程序时，我们经常需要创建 Web API 以提供数据服务。使用 PHP 编写 Web API 并返回 JSON 是一个常见的场景。在本文中，我们将探讨如何在 PHP 中编写 Web API 并返回 JSON 格式的示例代码。

前提条件

在开始之前，需要确保你已经安装了 PHP 开发环境。可以通过以下命令检查是否已经安装：

$ php --version

如果你还没有安装 PHP，请根据操作系统的要求进行安装。

准备数据

在编写 Web API 之前，我们需要准备一些数据。假设我们想要返回一组学生的信息，每个学生有姓名和年龄。

我们可以使用关联数组来表示学生信息，其中，每个元素代表一个学生。可以在 PHP 脚本中定义一个数组来存储学生信息，例如：

$students = [
    [
        "name" => "Alice",
        "age" => 18
    ],
    [
        "name" => "Bob",
        "age" => 20
    ],
    [
        "name" => "Charlie",
        "age" => 22
    ]
];

编写 Web API

现在我们可以编写 PHP 脚本来创建 Web API 并返回 JSON 数据了。

1. 创建一个名为 students-api.php 的文件。

2. 在文件中，使用 PHP 的 header 函数设置正确的响应头，使其返回 JSON 数据。代码如下：

header('Content-Type: application/json');

3. 在文件中，使用 json_encode 函数将学生数组转换为 JSON 格式数据。代码如下：

$data = json_encode($students);

4. 最后，通过 echo 函数将 JSON 数据输出。代码如下：

echo $data;

完整示例

以下是完整的 students-api.php 示例代码：

<?php

$students = [
    [
        "name" => "Alice",
        "age" => 18
    ],
    [
        "name" => "Bob",
        "age" => 20
    ],
    [
        "name" => "Charlie",
        "age" => 22
    ]
];

header('Content-Type: application/json');

$data = json_encode($students);

echo $data;

测试 API

要测试创建的 Web API 是否正常工作，可以在浏览器中访问 students-api.php 文件，然后查看返回的 JSON 数据。

总结

通过以上步骤，我们学习了如何在 PHP 中编写一个简单的 Web API 并返回 JSON 格式数据。你可以根据自己的实际需求扩展这个示例，例如从数据库中获取数据或添加身份验证等。

希望本文对你有所帮助！