gehrisandro/laravel-http-psr18

A PSR-18 wrapper for Laravel HTTP client

v0.0.1 2024-01-25 14:57 UTC

This package is auto-updated.

Last update: 2024-10-25 17:01:11 UTC


README

GitHub Workflow Status (main) Total Downloads Latest Version License

PSR-18 compatible HTTP Client for Laravel

This package provides a PSR-18 compatible wrapper for the Laravel HTTP Client.

This can be helpful if you want to use the Laravel HTTP Client in a package requiring a PSR-18 compatible HTTP Client.

If you find this package helpful, please consider sponsoring the maintainer:

Table of Contents

Get Started

Requires Laravel 10 (or at lease the illuminate/http package)

First, install the package via the Composer package manager:

composer require gehrisandro/laravel-http-psr18

Then, use the HttpPsr18::make() method to create a new instance of the PSR-18 compatible HTTP Client.

Usage

If you call the make() method without any arguments, the default Laravel HTTP Client will be used:

use HttpPsr18\HttpPsr18;

$client = HttpPsr18::make();

// example usage with OpenAI for Laravel (https://github.com/openai-php/laravel)
$openAI = \OpenAI::factory()
    ->withApiKey('*******')
    ->withHttpClient($client)
    ->make();

$response = $openAI->chat()->create([/* ... */]);

You can provide a custom Laravel HTTP Client instance as the first argument:

use HttpPsr18\HttpPsr18;
use Illuminate\Support\Facades\Http;

$client = HttpPsr18::make(Http::timeout(300));

With this package you get a PSR-18 compatible HTTP Client and you can make use of all the Laravel HTTP Client features. 🥳

use GuzzleHttp\Psr7\Request;
use HttpPsr18\HttpPsr18;
use Illuminate\Support\Facades\Http;

Http::fake([
    '*' => Http::response('Hello World'),
]);

$client = HttpPsr18::make();

$response = $client->sendRequest(new Request('GET', 'https://example.com'));

$response->getBody()->getContents(); // Hello World

Contributing

Thank you for considering contributing to LaravelHttpPsr18! The contribution guide can be found in the CONTRIBUTING.md file.

LaravelHttpPsr18 is an open-sourced software licensed under the MIT license.