如何将 date_sunset() 封装为 REST API 提供服务

M66 2025-05-30

在这篇文章中，我们将探讨如何将 PHP 的 date_sunset() 函数封装成一个 REST API。这样，其他应用或系统就可以通过 HTTP 请求来获取日落时间，而无需直接运行 PHP 脚本。

1. 什么是 date_sunset() 函数？

PHP 的 date_sunset() 函数用于计算指定地点的日落时间。该函数返回一个 Unix 时间戳，表示当天的日落时刻。其基本用法如下：

$timestamp = date_sunset(time(), SUNFUNCS_RET_TIMESTAMP, $latitude, $longitude);
echo "Sunset time: " . date("Y-m-d H:i:s", $timestamp);

在上面的例子中，$latitude 和 $longitude 表示位置的经纬度，SUNFUNCS_RET_TIMESTAMP 表示返回 Unix 时间戳格式。

2. 为什么要将 date_sunset() 封装成 REST API？

将 date_sunset() 封装成 REST API 后，您可以将该功能提供给其他应用程序，允许它们通过标准的 HTTP 请求来获取日落时间。这种方法适用于想要在没有 PHP 环境的情况下访问日落时间数据的场景，或者将该功能集成到其他服务中。

3. 使用 PHP 和 Slim Framework 封装 REST API

我们将使用 Slim Framework，它是一个轻量级的 PHP 框架，特别适用于构建 RESTful API。首先，确保您的开发环境中已经安装了 Composer 依赖管理工具，并安装 Slim Framework。

安装 Slim Framework

通过 Composer 安装 Slim Framework：

composer require slim/slim:"4.*"
composer require slim/psr7

创建 REST API

接下来，我们创建一个简单的 PHP 脚本，将 date_sunset() 函数封装成一个 API。

<?php

require 'vendor/autoload.php';

use Slim\Factory\AppFactory;

$app = AppFactory::create();

// 定义一个 REST API 路由
$app->get('/sunset', function ($request, $response, $args) {
    // 获取请求参数
    $latitude = $request->getQueryParams()['latitude'] ?? 0;
    $longitude = $request->getQueryParams()['longitude'] ?? 0;
    
    // 确保经纬度有效
    if (!is_numeric($latitude) || !is_numeric($longitude)) {
        $response->getBody()->write(json_encode(['error' => 'Invalid latitude or longitude']));
        return $response->withStatus(400)->withHeader('Content-Type', 'application/json');
    }

    // 获取日落时间
    $timestamp = date_sunset(time(), SUNFUNCS_RET_TIMESTAMP, $latitude, $longitude);

    // 格式化输出
    $dateTime = date("Y-m-d H:i:s", $timestamp);
    
    // 返回 JSON 响应
    $response->getBody()->write(json_encode(['sunset' => $dateTime]));
    return $response->withHeader('Content-Type', 'application/json');
});

// 运行应用
$app->run();

在这个代码片段中，我们使用 Slim Framework 创建了一个简单的 REST API 路由 /sunset，该路由接受 latitude 和 longitude 作为查询参数，计算并返回日落时间。返回的结果是 JSON 格式，包含了计算出来的日落时间。

4. 测试 API

启动该 PHP 脚本后，您可以通过以下 URL 来测试 API：

http://m66.net/sunset?latitude=34.0522&longitude=-118.2437

这将返回类似以下的 JSON 响应：

{
  "sunset": "2025-04-26 19:42:00"
}

5. 部署 API

如果您希望将这个 API 部署到生产环境，您可以选择将其托管在任何支持 PHP 的服务器上，或者使用云服务（例如 AWS、Heroku 等）。只要您的服务器支持 PHP 和 HTTP 请求，就可以运行此 API。

6. 扩展 API 功能

您可以根据需要扩展此 API。例如，您可以添加更多查询参数，如日期、返回不同格式的数据（如 Unix 时间戳或 UTC 时间），或者通过认证机制保护 API，使其只能被授权用户调用。

date_sunset