avris/api

该包已被放弃,不再维护。未建议替代包。

简化 REST API 调用

v1.0 2015-07-31 23:29 UTC

This package is auto-updated.

Last update: 2022-02-01 12:49:56 UTC


README

简化 REST API 调用

使用这个简单的PHP类(这是一个cURL包装器),你可以尽可能容易地操作REST API!

通过Composer安装

composer require avris/api

用法

$api = new Avris\Api\Api('https://api.example.com', 'json');
$response = $api->call('user/77/products', array('maxPrice' => 100));
$response = $api->call('user/77/products/123', array(), 'PUT', array('is_active' => 0));

第一次调用将发送一个 GET(默认方法)请求到 https://api.example.com/user/77/products?maxPrice=100

第二次调用将发送一个 PUT 请求到 https://api.example.com/user/77/products/123,数据为 is_active => 0

很简单,不是吗?

每个响应也会自动解码为JSON,因为我们已在构造函数的第二个参数中指定。接受的解码器有:text(纯文本,默认),jsonxml

通过使用 $api->addAuthentication,你可以让库向每个请求添加一组数据。接受类型有:query ($_GET),data ($_POST) 和 header(HTTP头)。例如

$api->addAuthentication('header', 'X-Token', '3d898f5fa97812b530352c28835f9f6b215cfa75');

将为每个请求添加一个 X-Token: 3d898f5fa97812b530352c28835f9f6b215cfa75 头。

要使用证书通过HTTPS连接到服务器,只需调用此函数

$api->setCertificate(__DIR__ . '/server.crt');

标志归功于: Aha-Soft