Download the PHP package uhura2/uhura without Composer
On this page you can find all versions of the php package uhura2/uhura. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package uhura
Uhura
A communications officer for RESTful APIs
Uhura is a dead simple RESTful API client for just about anything. No need to set up schemas or configure API endpoints, just tell Uhura what you want and go get it.
Installation
Install Uhura using composer.
Making Requests
Uhura maps what you ask for in your Demeter chain over to the URL that is used to access the resource you want.
Examples
Send a GET request to http://someapi.com/users
Send a GET request to http://someapi.com/users/1
Send a GET request to http://someapi.com/users/1/blogs/some-blog/comments
CRUD
CRUD operations are super simple with Uhura and are mapped to the create
, get
, update
and
delete
methods respectively.
Operation | Method Signature |
---|---|
Create | create($payload) |
Read | get() |
Update | update($payload) |
Delete | delete() |
create(array $payload)
Use Uhura's create
method to create resources. The create
method accepts an associative array
of attributes which are sent to the API in the request body as a x-www-form-urlencoded
string.
get()
Use Uhura's get
method to get API resources.
update($payload)
Use Uhura's update
method to update a resource. The update
method accepts an associative array
of attributes which are sent to the API in the request body as a x-www-form-urlencoded
string.
delete()
Use Uhura's delete
method to delete a resource.
Authentication
Uhura makes authenticated requests by adding the Authorization
header to each request that is
made.
Using HTTP Basic Auth
Tell Uhura to use HTTP Basic Auth with the useBasicAuthentication($username, $password)
method.
Explicitly Setting the Authorization Header
You can explicitly set the value of the Authorization
header by using Uhura's
authenticate($token)
method.
Working With Responses
By default, Uhura returns PSR7 compliant response objects.
Working with them would be as simple as, oh I don't know, a GuzzleHttp\Psr7\Response
object.
Response Handlers
You can tell Uhura to pass API responses through a Response Handler to augment the return value of
the various request methods. For instance, Uhura ships with a Json
Response Handler which consumes
the response and returns the decoded JSON response body.
Writing Custom Response Handlers
Writing your own custom response handler is super simple. Response Handlers are just simple classes
which define a handle($response)
method. Whatever is returned from the handle
method is what
Uhura will return to you.
Author
Colin DeCarlo, [email protected]
License
Uhura is licensed under the MIT License - see the LICENSE file for details.