用于处理API速率限制的类。

v1.0.0 2020-05-11 11:49 UTC

This package is auto-updated.

Last update: 2024-09-11 21:43:01 UTC


README

用于处理API速率限制的类。

安装

composer require alexkratky/apix

使用

require 'vendor/autoload.php';
use AlexKratky\API;
use AlexKratky\Cache;

Cache::setDirectory(__DIR__ . '/cache/');

$API_Endpoint = new API('v1');
if(!$API_Endpoint->request(new URL())) {
    echo $API_Endpoint->error();
    exit();
}

//valid API request. Continue with code.

信息

API类是用于处理API请求的类。在创建API端点时,会创建API接口,该接口将处理所有请求。为了响应请求,请求必须包含有效的API密钥(来自api_keys表中的一个)。有效意味着密钥必须存在且未达到速率限制。如果相应的路由有模板文件,则必须提供,但如果提供了函数,则会执行该函数,如果函数返回了内容,则结果将以美观的JSON字符串形式输出(结果将使用json_encode编码)并且也会将该响应保存为缓存文件。此缓存文件名是API密钥和URL的组合。