saloon-api-sdk

Saloon — API Integrations & SDKs in Laravel

Saloon is a PHP library for building API integrations and SDKs. Every integration is made of a Connector (one per API — base URL, default headers, auth, shared config) and Request classes (one per endpoint — HTTP method, endpoint, body). Requests are sent through the connector, which returns a Response.

This skill targets Saloon v4 (saloonphp/saloon: ^4.0). v4 has the same API as v3; it is a security release (see Security notes).

Installation (Laravel)

composer require saloonphp/saloon "^4.0"
composer require saloonphp/laravel-plugin "^4.0"
php artisan vendor:publish --tag=saloon-config

Artisan generators

Command	Creates
php artisan saloon:connector	Connector (--oauth for an OAuth2 connector)
php artisan saloon:request	Request
php artisan saloon:response	Custom response
php artisan saloon:plugin	Plugin trait
php artisan saloon:auth	Custom authenticator
php artisan saloon:list	List all API integrations

Conventions

• Place integrations in app/Http/Integrations/{ServiceName}/, e.g. ForgeConnector.php with request classes under Requests/.
• One connector per API. One request class per endpoint.
• Pass runtime values (IDs, payloads, tokens) as constructor arguments — connectors and requests are plain PHP classes.
• Prefer default* methods (defaultHeaders, defaultQuery, defaultBody, defaultAuth, defaultConfig) over setting values on instances at runtime.

Connector

<?php

namespace App\Http\Integrations\Forge;

use Saloon\Http\Connector;
use Saloon\Http\Auth\TokenAuthenticator;
use Saloon\Traits\Plugins\AlwaysThrowOnErrors;

class ForgeConnector extends Connector
{
    use AlwaysThrowOnErrors;

    public function __construct(protected readonly string $token) {}

    public function resolveBaseUrl(): string
    {
        return 'https://forge.laravel.com/api/v1';
    }

    protected function defaultHeaders(): array
    {
        return [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ];
    }

    protected function defaultAuth(): TokenAuthenticator
    {
        return new TokenAuthenticator($this->token);
    }
}