README

使用CakePHP插件与国家气象服务API交互

可用的方法基于国家气象服务网站上列出的路由，请参阅https://www.weather.gov/documentation/services-web-api#/。

内容

您可以使用composer将此插件安装到您的CakePHP应用程序中。

安装composer包的推荐方法是

composer require almostengr/national-weather-service-api

此插件可以像使用任何其他CakePHP组件一样使用。

在您的控制器类中添加以下代码。如果您控制器类中还没有initialize()方法，您可以复制并粘贴以下代码。

public function initialize(): void
{
    parent::initialize();

    $this->loadComponenent("NwsApi");
}

在您的控制器方法内部，您可以调用以下端点之一。

$this->NwsApi->getAlertTypes();

此插件为API URL和超时提供了默认值。要覆盖默认值，请向您的app_local.php文件中添加一个条目。

[
    "NwsApi":
    {
        "url": "api.weather.gov",
        "timeout": 30,
    }
]

问题和功能请求应提交到项目的issue tracker：https://github.com/almostengr/cakephp-nws-api。

即将推出的功能和功能也列在项目issue tracker上。

此插件的版本号格式如下。以下是一个示例

5.2024.07.26

"5"代表插件设计针对的主要CakePHP版本号

"2024.07.26"代表发布创建的日期，格式为YYYY-MM-DD