Added syntax highlighting
This commit is contained in:
57
README.md
57
README.md
@@ -14,40 +14,47 @@ Download the PHP library from Github, and require in your script like so:
|
||||
### Creating Request
|
||||
So you're probably wondering how using Unicorn makes creating requests in PHP easier, let's look at a working example:
|
||||
|
||||
$response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
|
||||
array(
|
||||
"parameter" => 23,
|
||||
"foo" => "bar"
|
||||
)
|
||||
);
|
||||
```php
|
||||
$response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
|
||||
array(
|
||||
"parameter" => 23,
|
||||
"foo" => "bar"
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
### File Uploads
|
||||
To upload files in a multipart form representation simply place an @ symbol before the path:
|
||||
|
||||
$response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
|
||||
array(
|
||||
"file" => "@/tmp/file.txt"
|
||||
)
|
||||
);
|
||||
```php
|
||||
$response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
|
||||
array(
|
||||
"file" => "@/tmp/file.txt"
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
### 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:
|
||||
|
||||
$response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
|
||||
json_encode(
|
||||
array(
|
||||
"parameter" => "value",
|
||||
"foo" => "bar"
|
||||
)
|
||||
)
|
||||
);
|
||||
```php
|
||||
$response = Unicorn::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
|
||||
json_encode(
|
||||
array(
|
||||
"parameter" => "value",
|
||||
"foo" => "bar"
|
||||
)
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
### Request Reference
|
||||
Unicorn::get($url, $headers = array());
|
||||
Unicorn::post($url, $headers = array(), $body = NULL);
|
||||
Unicorn::put($url, $headers = array(), $body = NULL);
|
||||
Unicorn::patch($url, $headers = array(), $body = NULL);
|
||||
Unicorn::delete($url, $headers = array());
|
||||
```php
|
||||
Unicorn::get($url, $headers = array());
|
||||
Unicorn::post($url, $headers = array(), $body = NULL);
|
||||
Unicorn::put($url, $headers = array(), $body = NULL);
|
||||
Unicorn::patch($url, $headers = array(), $body = NULL);
|
||||
Unicorn::delete($url, $headers = array());
|
||||
```
|
||||
|
||||
`url`
|
||||
Endpoint, address, or uri to be acted upon and requested information from.
|
||||
|
||||
Reference in New Issue
Block a user