Write API Integrations in Laravel and PHP Projects with Saloon

Write API Integrations in Laravel and PHP Projects with Saloon

Saloon is a Laravel/PHP package that allows you to write your API integrations in a beautiful, standardized syntax. At the heart of this package is request objects, which define how to get specific requests from an API. For example, to get a Laravel Forge server, you might define a GetForgeServerRequest class:

 1use App\Http\Saloon\Requests\GetForgeServerRequest;
 2 
 3$request = new GetForgeServerRequest(serverId: '123456');
 4 
 5$request->addHeader('Accept', 'application/json');
 6$request->addConfig('debug', true);
 7 
 8// This will overwrite all default headers.
 9$request->setHeaders($array);
10// This will overwrite all default configration options.
11$request->setConfig($array);
12 
13// Send the request and get the response body
14$response = $request->send();
15$data = $response->json();

And here's what the request class might look like:

 1use App\Http\Saloon\Connectors\ForgeConnector;
 2use Sammyjo20\Saloon\Constants\Saloon;
 3use Sammyjo20\Saloon\Http\SaloonRequest;
 4 
 5class GetForgeServerRequest extends SaloonRequest
 6{
 7    protected ?string $method = Saloon::GET;
 8    protected ?string $connector = ForgeConnector::class;
 9 
10    public function defineEndpoint(): string
11    {
12        return '/servers/' . $this->serverId;
13    }
14 
15    public function __construct(
16        public string $serverId
17    ){}
18}

You can also define default headers for the request via a defaultHeaders() method defined on a request class, which is merged with the base connector headers.

This package gives you an object-oriented, fluent system to work with, providing conventions to organize classes better around interacting with external APIs. Saloon works with both Laravel and any PHP project (PHP 8+) via composer, providing the following features:

• Simple syntax, standardizes the way you interact with APIs
• You don't have to worry about Guzzle/Http Facade/cURL
• Organize all your API integrations in one place
• Easily add on your own functionality with plugins
• Powerful interceptor logic to customize the response
• Supports Guzzle Handlers for unlimited customization
• Mocking requests for testing (Coming Soon)
• Framework agnostic

You can learn more about this package, get full installation instructions, and view the source code on GitHub.

Read More

Improve Debugging Output With Laravel Dumper

 Improve Debugging Output With Laravel Dumper

The Laravel dumper package improves on the default dumper with useful Laravel-specific enhancements.

You’ll get helpful information for various core Laravel objects, such as:

• Models
• Query Builders
• Service Container
• Database Connections
• Carbon Instances
• Requests and Responses

Take this simple Post model query, for example, which conveniently outputs the query builder SQL query at the top:

1Illuminate\Database\Eloquent\Builder {#332
2  sql: "select `title` from `posts` where `id` = '1'"
3  #connection: Illuminate\Database\MySqlConnection {#334 ▶}
4  #model: App\Models\Post {#320 …}
5  #eagerLoad: []
6   …5
7}

You can expect enhanced output automatically wherever you typically use dd() and even get the experience with chaining dd() calls onto the query builder. For example:

1Post::query()->select('title')->where('id', 1)->dd();

Would output something like the following:

If you still want to access the original default dump/dd behavior, you can use the following helper functions:

1// f = full
2ddf();
3dumpf();

If you’d like to learn more about the difference between the default experience and the enhancements made by the dumper package, check out the Laravel Dumper diffs on GitHub.

You can learn more about this package, get full installation instructions, and view the source code on GitHub.

Read More