vivaserver / restful_agent

一个用于以RESTful方式使用Curl访问URL的小型库

0.1.1 2013-07-25 22:25 UTC

This package is not auto-updated.

Last update: 2024-09-24 03:24:52 UTC


README

这是一个简单的Composer包,用于使用Curl访问RESTful资源。祝您使用愉快!

安装

最简单的方法是将它作为任何Composer包进行安装。只需在您的composer.json文件中添加一个条目,要求最新可用的版本

...
"require": {
  "vivaserver/restful_agent": "dev-master"
  ...
}
...

在您执行composer install命令时,该包将自动安装。

使用方法

在需要Composer自动加载器后创建RESTful Agent的新实例,您应该可以开始使用了。

require 'vendor/autoload.php';
$agent = new Resftful\Agent;

之后,您应该可以使用$agent实例执行任何HTTP请求。

DELETE请求

$agent->delete('http://www.example.com/resources/37');

GET请求

$agent->get('http://www.example.com/resources');

POST请求

将POST参数作为关联数组在URL之后传递。

$agent->post('http://www.example.com/resources',array('id'=>$id,'name'=>$name,'description'=>$description));

PUT请求

将PUT参数作为关联数组在URL之后传递。

$agent->put('http://www.example.com/resources/25',array('description'=>$description));

返回值

该库期望RESTful资源使用HTTP响应码来确认其返回消息的状态。因此,库方法返回值始终是一个具有两个属性的对象

  • code

    资源响应的HTTP状态码。

  • body

    返回响应的正确主体。

处理返回值

了解以上内容后,只需考虑响应代码以对资源的状态采取正确行动。例如

$response = $agent->get('http://www.example.com/resources/54');
$result = $response->body;
switch ($response->code) {
  case 200:
    return $result;
  break;

  case 404:
    return NULL;
  break;

  case 500:
    error_log($result);
  break;
}

备注

正如预期的那样,所有方法返回值都是资源对请求的输出。

但请注意,在库失败时,将抛出异常。因此,建议在try/catch块中使用它,如下所示

try {
  $agent->delete('http://www.example.com/resource/37');
}
catch (Exception $e) {
  error_log($e->getMessage());
}

许可证

本软件根据MIT许可证发布。

版权

©2013 Cristian R. Arroyo