toohamster/ws-http

ws-http：简洁、轻量级的HTTP客户端库

维护者

详细信息

github.com/toohamster/ws-http

主页

源代码

问题

安装数: 20,899

依赖者: 2

建议者: 0

安全: 0

星标: 56

关注者: 5

分支: 14

开放问题: 0

1.0.2 2016-08-04 06:05 UTC

Requires

  • php: >=5.4

MIT 79cf6ef17df8df80c0bb86451bd3e1d0adebd60b

  • toohamster <449211678.woop@qq.com>

httpws-http

This package is not auto-updated.

Last update: 2024-09-23 13:18:20 UTC

README

简单轻量的HTTP 客户端工具库

ws-http

适用于 HTTP API 测试，支持 ssl、基本认证、代理、自定义请求头以及常用HTTP请求方法。

需求（Requirements）

安装（Installation）

使用（Using）Composer

在composer.json文件中添加以下行（To install ws-http with Composer, just add the following to your composer.json file）

{
    "require": {
        "toohamster/ws-http": "*"
    }
}

或者手动运行命令（or by running the following command）

php composer require toohamster/ws-http

Http 请求使用（Http Request Usage）

创建一个请求（Creating a Request）

$httpRequest = \Ws\Http\Request::create();

支持的方法（Support Method）

// set config
$httpRequest->jsonOpts($assoc = false, $depth = 512, $options = 0);
$httpRequest->verifyPeer($enabled);
$httpRequest->verifyHost($enabled);
$httpRequest->verifyFile($file);
$httpRequest->getVerifyFile();
$httpRequest->timeout($seconds);
$httpRequest->defaultHeaders($headers);
$httpRequest->defaultHeader($name, $value);
$httpRequest->clearDefaultHeaders();
$httpRequest->curlOpts($options);
$httpRequest->curlOpt($name, $value);
$httpRequest->clearCurlOpts();
$httpRequest->cookie($cookie);
$httpRequest->cookieFile($cookieFile);
$httpRequest->auth($username = '', $password = '', $method = CURLAUTH_BASIC);
$httpRequest->proxy($address, $port = 1080, $type = CURLPROXY_HTTP, $tunnel = false);
$httpRequest->proxyAuth($username = '', $password = '', $method = CURLAUTH_BASIC);

// http call
$httpRequest->get($url, $headers = [], $parameters = null);
$httpRequest->head($url, $headers = [], $parameters = null);
$httpRequest->options($url, $headers = [], $parameters = null);
$httpRequest->connect($url, $headers = [], $parameters = null);
$httpRequest->post($url, $headers = [], $body = null);
$httpRequest->delete($url, $headers = [], $body = null);
$httpRequest->put($url, $headers = [], $body = null);
$httpRequest->patch($url, $headers = [], $body = null);
$httpRequest->trace($url, $headers = [], $body = null);

以下是一些简单实例（Let's look at a working example）

$headers = array('Accept' => 'application/json');
$query = array('foo' => 'hello', 'bar' => 'world');

$response = $httpRequest->post('http://mockbin.com/request', $headers, $query);

$response->code;        // 请求响应码(HTTP Status code)
$response->curl_info;   // curl信息(HTTP Curl info)
$response->headers;     // 响应头(Headers)
$response->body;        // 处理后的响应消息体(Parsed body), 默认为 false
$response->raw_body;    // 原始响应消息体(Unparsed body)

JSON 请求（Requests） (application/json)

$headers = array('Accept' => 'application/json');
$data = array('name' => 'ahmad', 'company' => 'mashape');

$body = Ws\Http\Request\Body::json($data);

$response = $httpRequest->post('http://mockbin.com/request', $headers, $body);

注意（Notes）

  • Content-Type 会自动设置为（headers will be automatically set to） application/json

表单请求（Form Requests） (application/x-www-form-urlencoded)

$headers = array('Accept' => 'application/json');
$data = array('name' => 'ahmad', 'company' => 'mashape');

$body = Ws\Http\Request\Body::form($data);

$response = $httpRequest->post('http://mockbin.com/request', $headers, $body);

注意（Notes）

  • Content-Type 会自动设置为（headers will be automatically set to） application/x-www-form-urlencoded

multipart 请求（Multipart Requests） (multipart/form-data)

$headers = array('Accept' => 'application/json');
$data = array('name' => 'ahmad', 'company' => 'mashape');

$body = Ws\Http\Request\Body::multipart($data);

$response = $httpRequest->post('http://mockbin.com/request', $headers, $body);

注意（Notes）

  • Content-Type 会自动设置为（headers will be automatically set to） multipart/form-data。

文件上传（Multipart File Upload）

$headers = array('Accept' => 'application/json');
$data = array('name' => 'ahmad', 'company' => 'mashape');
$files = array('bio' => '/path/to/bio.txt', 'avatar' => '/path/to/avatar.jpg');

$body = Ws\Http\Request\Body::multipart($data, $files);

$response = $httpRequest->post('http://mockbin.com/request', $headers, $body);
$headers = array('Accept' => 'application/json');
$body = array(
    'name' => 'ahmad', 
    'company' => 'mashape'
    'bio' => Ws\Http\Request\Body::file('/path/to/bio.txt', 'text/plain'),
    'avatar' => Ws\Http\Request\Body::file('/path/to/my_avatar.jpg', 'text/plain', 'avatar.jpg')
);

$response = $httpRequest->post('http://mockbin.com/request', $headers, $body);

自定义消息体（Custom Body）

可以使用Ws\Http\Request\Body类提供的方法来生成消息体，或使用PHP自带的序列化函数来生成消息体（Sending a custom body such rather than using the Ws\Http\Request\Body helpers is also possible, for example, using a serialize body string with a custom Content-Type）

$headers = array('Accept' => 'application/json', 'Content-Type' => 'application/x-php-serialized');
$body = serialize((array('foo' => 'hello', 'bar' => 'world'));

$response = $httpRequest->post('http://mockbin.com/request', $headers, $body);

授权校验（Authentication）

$httpRequest->auth($username, $password, $method);// default is CURLAUTH_BASIC

支持的方法（Supported Methods）

// custom auth method
$httpRequest->proxyAuth('username', 'password', CURLAUTH_DIGEST);

Cookies

$httpRequest->cookie($cookie)
$httpRequest->cookieFile($cookieFile)

$cookieFile 参数必须是可读取的文件路径（must be a correct path with write permission）。

请求对象（Request Object）

$httpRequest->get($url, $headers = array(), $parameters = null)
$httpRequest->post($url, $headers = array(), $body = null)
$httpRequest->put($url, $headers = array(), $body = null)
$httpRequest->patch($url, $headers = array(), $body = null)
$httpRequest->delete($url, $headers = array(), $body = null)
  • url - 请求地址（Endpoint, address, or uri to be acted upon and requested information from）
  • headers - 请求头（Request Headers as associative array or object）
  • body - 请求消息体（Request Body as associative array or object）

可以使用标准的HTTP方法，也可以使用自定义的HTTP方法（You can send a request with any standard or custom HTTP Method）

$httpRequest->send(Ws\Http\Method::LINK, $url, $headers = array(), $body);

$httpRequest->send('CHECKOUT', $url, $headers = array(), $body);

响应对象（Response Object）

  • code - 请求响应码（HTTP Status code）
  • curl_info - HTTP curl信息（HTTP Curl info）
  • headers - 响应头（HTTP Response Headers）
  • body - 处理后的响应消息体（Parsed body）
  • raw_body - 原始响应消息体（Unparsed body）

高级设置（Advanced Configuration）

自定义json_decode选项（Custom JSON Decode Flags）

$httpRequest->jsonOpts(true, 512, JSON_NUMERIC_CHECK & JSON_FORCE_OBJECT & JSON_UNESCAPED_SLASHES);

超时设置（Timeout）

$httpRequest->timeout(5); // 5s timeout

代理（Proxy）

可以设置代理类型（you can also set the proxy type to be one of） CURLPROXY_HTTP、CURLPROXY_HTTP_1_0、CURLPROXY_SOCKS4、CURLPROXY_SOCKS5、CURLPROXY_SOCKS4A、和 CURLPROXY_SOCKS5_HOSTNAME。

查看cURL文档获取更多信息.

// quick setup with default port: 1080
$httpRequest->proxy('10.10.10.1');

// custom port and proxy type
$httpRequest->proxy('10.10.10.1', 8080, CURLPROXY_HTTP);

// enable tunneling
$httpRequest->proxy('10.10.10.1', 8080, CURLPROXY_HTTP, true);
代理授权验证（Proxy Authentication）
// basic auth
$httpRequest->proxyAuth('username', 'password', CURLAUTH_DIGEST);

默认请求头（Default Request Headers）

$httpRequest->defaultHeader('Header1', 'Value1');
$httpRequest->defaultHeader('Header2', 'Value2');

批量配置（You can set default headers in bulk by passing an array）

$httpRequest->defaultHeaders(array(
    'Header1' => 'Value1',
    'Header2' => 'Value2'
));

清除配置（You can clear the default headers anytime with）

$httpRequest->clearDefaultHeaders();

默认cURL选项（Default cURL Options）

您可以为每次请求设置默认的cURL选项（You can set default cURL options that will be sent on every request）

$httpRequest->curlOpt(CURLOPT_COOKIE, 'foo=bar');

批量配置（You can set options bulk by passing an array）

$httpRequest->curlOpts(array(
    CURLOPT_COOKIE => 'foo=bar'
));

清除配置（You can clear the default options anytime with）

$httpRequest->clearCurlOpts();

SSL验证（SSL validation）

$httpRequest->verifyPeer(false); // Disables SSL cert validation

默认为true。

Http Watcher 使用（Http Watcher Usage）

支持的方法（Support Method）

$watcher = \Ws\Http\Watcher::create($httpResponse);

$watcher->assertStatusCode($assertedStatusCode);
$watcher->assertTotalTimeLessThan($assertedTime);
$watcher->assertHeadersExist(array $assertedHeaders = []);
$watcher->assertHeaders(array $assertedHeaders = []);
$watcher->assertBody($assertedBody, $useRegularExpression = false);
$watcher->assertBodyJson($asserted, $onNotEqualVarExport = false);
$watcher->assertBodyJsonFile($assertedJsonFile, $onNotEqualPrintJson = false);
例子（Examples）
$httpRequest = \Ws\Http\Request::create();

$httpResponse = $httpRequest->get("https://api.github.com");
$watcher = \Ws\Http\Watcher::create($httpResponse);

$watcher
         ->assertStatusCode(200)
         ->assertHeadersExist(array(
            "X-GitHub-Request-Id",
            "ETag"
         ))
         ->assertHeaders(array(
            "Server" => "GitHub.com"
         ))
         ->assertBody('IS_VALID_JSON')
         ->assertTotalTimeLessThan(2);
$httpRequest = \Ws\Http\Request::create();
$httpResponse = $httpRequest->get("https://freegeoip.net/json/8.8.8.8");
$watcher = \Ws\Http\Watcher::create($httpResponse);

$watcher
         ->assertStatusCode(200)
         ->assertHeadersExist(array(
            "Content-Length"
         ))
         ->assertHeaders(array(
            "Access-Control-Allow-Origin" => "*"
         ))
         ->assertBodyJsonFile(dirname(__DIR__) . "/tests/Ws/Http/_json/freegeoip.net.json");

查看所有示例（查看完整示例） https://github.com/toohamster/ws-http/blob/master/tests/Ws/Http/ATest.php。