README

一个简单的PHP cURL REST客户端。

安装

composer require chriha/rest-client

用法

定义你的选项

$options = [
    'url' => 'http://api.localhost/v1',
];

查看 \Chriha\Clients\Rest::getDefaultOptions() 以获取所有默认选项。

GET

$rest = new \Chriha\Clients\Rest( $options );
$rest->get( '/posts' );

POST

$post = [
    "title" => "lorem",
    "body"  => "lorem ipsum dolor set"
];

$rest = new \Chriha\Clients\Rest( $options );
$rest->post( '/posts', $post );

PUT / PATCH

$post = [
    "title" => "lorem"
];

$rest = new \Chriha\Clients\Rest( $options );
$rest->put( '/posts/1', $post );
$rest->patch( '/posts/1', $post );

DELETE

$rest = new \Chriha\Clients\Rest( $options );
$rest->delete( '/posts/1' );

选项

允许自签名证书

仅建议在开发环境中使用，因此默认值为 false

$options = [
    'allow_self_signed' => true,
];

设置额外的cURL选项

$options = [
    'curl_options' => [...],
];

OAuth 1.0认证

$options = [
    'authentication' => 'oauth1',
    'token'          => 'YOUR_API_TOKEN',
    'secret'         => 'YOUR_API_SECRET',
];

使用CLI REST客户端

为项目中的客户端创建别名，例如 alias rest='vendors/bin/rest' 以简化使用。

使用以下命令，您可以通过rest客户端进行请求。

$ ./rest GET http://api.localhost.io/v1/posts "parameters=specified&as=simple&query=string" "Content-Type:application/json;Accept-Charset: utf-8"

如果您想使用 token 和 secret 进行认证，可以将它们作为JSON放置在项目根目录的 .rest 文件中

{
    "token": "YOUR_API_TOKEN",
    "secret": "YOUR_API_SECRET"
}

rest客户端的输出将如下所示

Request took 23.45ms
Response Code: 200
Response Body:
{
    "meta": "info",
    "data": [
        {
            "title": "lorem"
        }
    ]
}