bitmotor/unirest-php
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added version requirement

Browse Source
This commit is contained in:
thefosk
2013-10-22 10:53:40 -07:00
parent 90d18df40f 0701ed4896
commit a944695d96
1 changed files with 20 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@@ -1,19 +1,23 @@
Unirest-PHP # Unirest for PHP
============================================
Unirest is a set of lightweight HTTP libraries available in PHP, Ruby, Python, Java, Objective-C. Unirest is a set of lightweight HTTP libraries available in multiple languages.
<<<<<<< HEAD
Documentation Documentation
------------------- -------------------
### Installing ### Installing
Unirest-PHP required `PHP v5.3+`. Download the PHP library from Github, and require in your script like so: Unirest-PHP required `PHP v5.3+`. Download the PHP library from Github, and require in your script like so:
=======
## Installing
Download the `PHP` library from Github, and require in your script like so:
>>>>>>> 0701ed4896e3e47643dfc3fbb93a97780cde8978
```php ```php
require_once './lib/Unirest.php'; require_once './lib/Unirest.php';
``` ```
#### Using Composer ### Using Composer
[Composer](http://getcomposer.org/) is a package manager for PHP. [Composer](http://getcomposer.org/) is a package manager for PHP.
@@ -38,7 +42,7 @@ Include the library in your project with:
require 'vendor/autoload.php'; require 'vendor/autoload.php';
```` ````
### Creating Request ## Creating Request
So you're probably wondering how using Unirest makes creating requests in PHP easier, let's look at a working example: So you're probably wondering how using Unirest makes creating requests in PHP easier, let's look at a working example:
```php ```php
@@ -50,7 +54,7 @@ $response = Unirest::post("http://httpbin.org/post", array( "Accept" => "applica
); );
``` ```
### File Uploads ## File Uploads
To upload files in a multipart form representation simply place an @ symbol before the path: To upload files in a multipart form representation simply place an @ symbol before the path:
```php ```php
@@ -61,7 +65,7 @@ $response = Unirest::post("http://httpbin.org/post", array( "Accept" => "applica
); );
``` ```
### Custom Entity Body ## Custom Entity Body
Sending a custom body such as a JSON Object rather than a string or form style parameters we utilize json_encode for the body: Sending a custom body such as a JSON Object rather than a string or form style parameters we utilize json_encode for the body:
```php ```php
$response = Unirest::post("http://httpbin.org/post", array( "Accept" => "application/json" ), $response = Unirest::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
@@ -74,7 +78,7 @@ $response = Unirest::post("http://httpbin.org/post", array( "Accept" => "applica
); );
``` ```
### Request Reference # Request
```php ```php
Unirest::get($url, $headers = array()); Unirest::get($url, $headers = array());
Unirest::post($url, $headers = array(), $body = NULL); Unirest::post($url, $headers = array(), $body = NULL);
@@ -83,52 +87,14 @@ Unirest::patch($url, $headers = array(), $body = NULL);
Unirest::delete($url, $headers = array()); Unirest::delete($url, $headers = array());
``` ```
`url` - `url` - Endpoint, address, or uri to be acted upon and requested information from.
Endpoint, address, or uri to be acted upon and requested information from. - `headers` - Request Headers as associative array or object
- `body` - Request Body associative array or object
`headers` # Response
Request Headers as associative array or object
`body`
Request Body associative array or object
### Response Reference
Upon recieving a response Unirest returns the result in the form of an Object, this object should always have the same keys for each language regarding to the response details. Upon recieving a response Unirest returns the result in the form of an Object, this object should always have the same keys for each language regarding to the response details.
`code` - `code` - HTTP Response Status Code (Example `200`)
HTTP Response Status Code (Example `200`) - `headers` - HTTP Response Headers
- `body` - Parsed response body where applicable, for example JSON responses are parsed to Objects / Associative Arrays.
`headers` - `raw_body` - Un-parsed response body
HTTP Response Headers
`body`
Parsed response body where applicable, for example JSON responses are parsed to Objects / Associative Arrays.
`raw_body`
Un-parsed response body
License
---------------
The MIT License
Copyright (c) 2013 Mashape (http://mashape.com)
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.