Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nahid/apiz
APIZ is a PHP HTTP client development kit
https://github.com/nahid/apiz
api api-boilerplate api-client boilerplate php php-api-clients
Last synced: about 18 hours ago
JSON representation
APIZ is a PHP HTTP client development kit
- Host: GitHub
- URL: https://github.com/nahid/apiz
- Owner: nahid
- License: mit
- Created: 2017-07-09T19:38:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-03T03:18:28.000Z (11 days ago)
- Last Synced: 2024-11-03T04:18:15.408Z (11 days ago)
- Topics: api, api-boilerplate, api-client, boilerplate, php, php-api-clients
- Language: PHP
- Homepage:
- Size: 351 KB
- Stars: 58
- Watchers: 4
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# APIZ
APIZ is a PHP API Client Development Kit, it helps you to manage HTTP API call in OOP way. You can easily handle and isolate all kinds of REST API calls and their responses by using this package.
## Requirements
- PHP >= 5.5.9
## Installations
```shell
composer require nahid/apiz
```
## Configurations
There are no extra configurations for this package.
## Usage
Lets see an example to consume API from https://reqres.in.
Suppose you need to create several API services for your project. Your service directory is
`app/Services`. Now we are going to develop a service for https://reqres.in and make a class file `ReqResApiService.php`
which will extend `\Apiz\AbstractApi` class.
```php
namespace App\Services;
use Apiz\AbstractApi;
class ReqResApiService extends AbstractApi
{
protected function getBaseURL()
{
return 'https://reqres.in';
}
}
```
`getBaseURL()` is an abstract method of the `AbstractApi` class. You need to override this method to set the proper base URL for your API.
Few APIs have a common prefix in their URL. Like, here `reqres.in` have a prefix `api` on every endpoint.
So, we'll override the `getPrefix()` method to define the Prefix.
```php
namespace App\Services;
use Apiz\AbstractApi;
class ReqResApiService extends AbstractApi
{
protected function getBaseURL()
{
return 'https://reqres.in';
}
protected function getPrefix()
{
return 'api';
}
}
```
Now let's make a method to get all users info.
```php
namespace App\Services;
use Apiz\AbstractApi;
class ReqResApiService extends AbstractApi
{
protected function getBaseURL()
{
return 'https://reqres.in';
}
protected function getPrefix()
{
return 'api';
}
public function getAllUsers()
{
$response = $this->get('users');
if ($response->getStatusCode() === 200) {
return $response()->toArray();
}
return [];
}
}
```
So, we are basically making a `GET` request to the URL `https://reqres.in/api/users`.
See, how easy it is to manage an API now?
Let's see another example.
## Post Request with Form Params
```php
public function createUser(array $data)
{
$response = $this->withFormParams($data)
->post('create');
if ($response->getStatusCode() === 201) {
return $response()->toArray();
}
return null;
}
```
## Default Headers
Sometimes we need to bind some headers with all the requests. Suppose if you want to deal with the Github API, you have to send `access_token` in every request with the headers.
So APIZ provide you a handy way to deal with this problem. Just override `AbstractApi::getDefaultHeaders()`.
```php
protected function getDefaultHeaders()
{
return [
'access_token' => $_ENV['GITHUB_ACCESS_TOKEN'],
];
}
```
Cool, right?
You can easily use all HTTP verbs like `get`, `post` etc. It's totally hassle free.
See more examples in the [Examples Folder](./Examples).
## Query over Response Data
Sometimes we receive huge payload as a response from the APIs.
It's quite daunting to parse proper data from that big payload.
No worries!
We're using a powerful Query parser, named [QArray](https://github.com/nahid/qarray) by default to parse and query over the Response data.
Let's see how we can use this parser to parse the response we got for `getAllUsers` method from our previous example.
```php
public function getFirstUser()
{
$users = $this->get('users');
return $users->query()->from('data')->first();
}
```
We're getting list of users in the `data` key in the response. From that we're collecting the first data.
See, how easy it is!
You can find detail usage of the QArray [here](https://github.com/nahid/qarray).
Additionally, there is a secret sauce for you.
If you don't want to query like: `$users->query()`, you can just do it like this: `$users()`. That means the response object is invokable and behave exactly like calling the `query()` method.
You're welcome. :D
## Overriding HTTP Client
By default we are using `Guzzle` as our HTTP Client. But you are not bound to use this. You can easily use your own PSR7 supported HTTP Client with `Apiz`.
Just pass an instance of your HTTP Client to our `setClient()` method.
See an example [here](./Examples/API%20with%20Different%20Client).
Here is our GuzzleClient to get an idea how your Client should look like:
```php
send(... $args);
}
}
```
## List of methods for common HTTP verbs
- `get(string $uri)`
- `post(string $uri)`
- `put(string $uri)`
- `delete(string $uri)`
- `head(string $uri)`
- `options(string $uri)`
## List of Available methods
- `getPrefix():string`: override this method to define the common prefix, if you need it
- `setClient($client)` : pass a PSR7 supported Client instance, only if you need to override the default Guzzle HTTP Client
- `withFormParams(array)`: pass Form parameters data for requests like POST, PATCH, UPDATE
- `withHeaders(array)`: pass Header data
- `withQueryParams(array)`: pass Query Parameter data
- `withFormData(array)`: pass Multipart form data
- `getDefaultHeaders():array`: override to define default Headers, if you have any
- `getDefaultQueries():array`: override to define default queries, if you have any
- `skipDefaultHeaders(bool)`
- `skipDefaultQueries(bool)`
- `allowRedirects(array)`
- `basicAuth(string $username, string $password [, array $options])`
- `body(string)`: Set request body
- `json(array)`: Set JSON data to be passed as Request Body
- `file(string $name, string $file_path, string $filename [, array $headers])`
- `params(array $params)`
### Contribution
Feel free send feedback and issues. Contributions to improve this package is most welcome too.