Laravel : Sanctum, Resources et versions dâAPI
Lâapproche par dĂ©faut de Laravel est plus manuelle que celle dâAPI Platform, et câest souvent voulu. Routes, contrĂŽleurs et formes de rĂ©ponse restent explicites, au prix dâun peu plus de code par endpoint.
Sanctum gĂšre lâauthentification des clients SPA et mobiles (par session) et celle des consommateurs tiers (par jeton), depuis un seul paquet.
composer require laravel/sanctum
php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"
php artisan migrate
// issuing a token
$token = $user->createToken('mobile-app')->plainTextToken;
// protecting a route
Route::middleware('auth:sanctum')->get('/api/user', fn (Request $r) => $r->user());
Les API Resources donnent Ă un modĂšle une forme JSON stable. Vos colonnes de base de donnĂ©es et votre contrat public cessent dâĂȘtre la mĂȘme chose :
class ProductResource extends JsonResource
{
public function toArray(Request $request): array
{
return [
'id' => $this->id,
'name' => $this->name,
'price_usd' => number_format($this->price, 2),
];
}
}
// in a controller
return ProductResource::collection(Product::paginate());
Le versionnement est le plus souvent un préfixe de route, et délibérément rien de plus :
Route::prefix('v1')->group(base_path('routes/api_v1.php'));
Route::prefix('v2')->group(base_path('routes/api_v2.php'));
Quand le choisir
Le choix par dĂ©faut pour un projet Laravel qui expose une API Ă cĂŽtĂ© dâune application web, ou pour une API autonome de taille petite Ă moyenne oĂč le contrĂŽle de chaque forme de rĂ©ponse compte plus que la gĂ©nĂ©ration.
Quand ce nâest pas le bon outil
Un gros modĂšle de donnĂ©es qui Ă©volue vite, oĂč une classe Resource Ă©crite Ă la main par modĂšle devient de la maintenance. Câest le cas pour lequel API Platform est fait.
Sous le capot : Sanctum stocke les jetons dâAPI hachĂ©s, comme des mots de passe, mais avec la fonction
hash()de PHP plutĂŽt quâavecpassword_hash(). Un jeton est une chaĂźne alĂ©atoire Ă forte entropie, pas un mot de passe choisi par un humain, et un hachage rapide suffit donc Ă le protĂ©ger.