skizu/simpleapi

简单的API包装器,易于缓存和节流

dev-master 2015-07-23 13:36 UTC

This package is not auto-updated.

Last update: 2024-09-28 15:49:40 UTC


README

这是一个简单的API包装器,具有快速和易于的缓存和节流功能。

配置

要配置新的API密钥,必须在.env文件中注册它,在示例中,EXAMPLE_KEY 是密钥。

# Required 
EXAMPLE_KEY_API_URL=http://api.example.com/

# Optional
EXAMPLE_KEY_API_THROTTLE_LIMIT=100
EXAMPLE_KEY_API_STORAGE_TIME=1440
EXAMPLE_KEY_API_CACHE_TIME=60

用法

示例解析 http://api.example.com/baz?foo=bar

$api = new SimpleAPI\RegisterAPI('example_key');

$query = [
	'foo' => 'bar'
];

$result = $api->action('baz')->lookup($query);

错误处理

该库通过抛出异常来工作,您需要捕获这些异常。

  • 无效配置 ConfigException
  • API节流 ThrottleException
  • 请求错误 RequestException
  • 响应错误 ResponseException
  • 服务器错误 ServerException