Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paveldanilin/rest-client
REST client for PHP 7.4+
https://github.com/paveldanilin/rest-client
interceptor json-rest-client middleware psr-18 psr-7 rest-client
Last synced: 3 months ago
JSON representation
REST client for PHP 7.4+
- Host: GitHub
- URL: https://github.com/paveldanilin/rest-client
- Owner: paveldanilin
- License: mit
- Created: 2022-08-08T13:20:31.000Z (over 2 years ago)
- Default Branch: 2.0
- Last Pushed: 2024-10-27T04:57:04.000Z (3 months ago)
- Last Synced: 2024-10-27T05:40:22.917Z (3 months ago)
- Topics: interceptor, json-rest-client, middleware, psr-18, psr-7, rest-client
- Language: PHP
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# RestClient
RestClient is [an interface](src/RestClientInterface.php) representing the main entry point for performing REST requests.
RestClient is a handy tool that adds a list of extra features to a Psr/HttpClient (at the same time it is not intended to
replace Psr/HttpClient):
1. Serializer/Deserialize request/response body.
2. Intercept request (allows to modify request before sending or process a response object).
3. Retry strategy.
## Install
```shell
composer require paveldanilin/rest-client
```
## Quick Examples
### Create a new REST client
For simplicity, we are using a Guzzle HTTP client, but you are free to use any PSR-18 compliant HTTP client.
```php
// PSR-18 HTTP client
$httpClient = new GuzzleHttp\Client([
'base_uri' => 'https://animechan.vercel.app',
]);
// Serializer
$serializer = new \RestClient\Serialization\Symfony\JsonSymfonySerializer();
$restClient = new \RestClient\RestClient($httpClient, $serializer);
```
### Define an application response model
```php
class AnimeQuote
{
private string $anime = '';
private string $character = '';
private string $quote = '';
public function getAnime(): string
{
return $this->anime;
}
public function setAnime(string $anime): void
{
$this->anime = $anime;
}
public function getCharacter(): string
{
return $this->character;
}
public function setCharacter(string $character): void
{
$this->character = $character;
}
public function getQuote(): string
{
return $this->quote;
}
public function setQuote(string $quote): void
{
$this->quote = $quote;
}
}
```
### Get an object
Take a look at [the example](example/anime_quote.php).
```php
/** @var AnimeQuote|null $quote */
$quote = $restClient->getForObject('/api/random', AnimeQuote::class);
print "------------------------------------------\n";
print 'Anime: ' . $quote->getAnime() . "\n";
print 'Character: ' . $quote->getCharacter() . "\n";
print 'Quote: ' . $quote->getQuote() . "\n";
print "------------------------------------------\n";
```
### Get a list of objects
Take a look at [the example](example/JsonPlaceholder/print_blog_posts.php).
```php
/** @var array $models */
$models = $restClient->getForObject('/api/models', \RestClient\Helpers\asList(ApiModel::class));
```
### Intercept request
Use case of interceptor:
- Request header modification
- Request and response logging
- Request denial based on certain request parameters
- Changing the request URL address
Out of the box you can use following interceptors:
* [Log request](src/Interceptor/LogRequestInterceptor.php)
* [Retry](src/Interceptor/RetryInterceptor.php)
* [Add header](src/Interceptor/AddHeaderInterceptor.php)
* [Callable](src/Interceptor/CallableInterceptor.php)
Did not find a right interceptor? Do not get upset!
It's easy to create a new one, just implement the following interface:
```php
interface RequestInterceptorInterface
{
/**
* @throws ClientExceptionInterface
*/
public function intercept(RequestInterface $request, ContextInterface $context, RequestExecutionInterface $execution): ResponseInterface;
}
```
Set interceptors
```php
$restClient->setInterceptors([
new \RestClient\Interceptor\RetryInterceptor(), // <- Retry request in case of [429] or [503] response status
new \RestClient\Interceptor\RequestIdInterceptor(), // <- Add Request-Id header (uuid v4)
new \RestClient\Interceptor\LogRequestInterceptor($logger), // <- Log before/after and exception
]);
```