Doc API & Postman

Votre API est documentée dès qu'elle existe, avec Scramble pour la doc OpenAPI interactive et des collections Postman pour votre équipe.

Scramble : doc OpenAPI instantanée

Les contrôleurs, requests et resources générés sont écrits pour que Scramble puisse les analyser sans annotations ni configuration :

composer require dedoc/scramble --dev
php artisan serve

Ouvrez http://localhost:8000/docs/api :

Depuis VS Code, le bouton Open API Docs de l'extension fait tout le trajet en un clic, y compris démarrer le serveur si aucun ne tourne et proposer l'installation de Scramble s'il manque.

Ce que vous obtenez automatiquement :

• Swagger UI interactif : testez les endpoints depuis le navigateur avec Send API Request
• Schémas auto-détectés : PostRequest, PostResource… déduits des règles de FormRequest et de la structure des Resources
• Les règles de validation deviennent des contraintes : required|string|max:255 devient un champ requis avec <= 255 characters dans la doc
• Exemples de requête/réponse : les corps JSON d'exemple sont générés pour vous
• Endpoints groupés : chaque entité a sa section avec toutes les opérations CRUD

URL	Description
/docs/api	Swagger UI interactif
/docs/api.json	Spécification OpenAPI 3.x brute (JSON)

TIP

Scramble est une dépendance de dev, comme le générateur lui-même. Rien de tout cela ne part en production.

Collection Postman

php artisan make:fullapi Post --fields="title:string" --postman

Exporte postman_collection.json à la racine du projet, au schéma Postman v2.1 :

• Un dossier par entité
• Des requêtes List, Create, Show, Update et Delete pré-configurées
• Des corps de requête d'exemple avec des valeurs adaptées aux champs
• Une variable base_url (par défaut http://localhost:8000/api)

Importez-le dans Postman et donnez-le à votre équipe frontend le matin même.