Le designer d'API
Le designer d’API vous laisse concevoir une API complète directement dans Restorm : vous décrivez vos données et vos routes, Restorm s’occupe du reste — il sert votre design comme un vrai serveur mock, et il génère le code de votre application à partir de modèles.
C’est l’outil idéal pour démarrer une API avant que le back-end n’existe : maquettez le contrat, faites-le tester à vos clients, et gardez le tout versionné dans votre projet.
Un design, plusieurs sections
Section titled “Un design, plusieurs sections”Un design se crée comme n’importe quel élément : clic droit sur un dossier ▸ Ajouter ▸ Design d’API. Il s’ouvre dans son propre onglet et regroupe plusieurs sections, accessibles depuis la barre latérale :
| Section | À quoi elle sert |
|---|---|
| Modèles | Vos entités et leurs propriétés — voir Modèles, enums et propriétés. |
| Enums | Des ensembles de valeurs fermés, réutilisables comme type de propriété. |
| Routes | Les points d’entrée de l’API, regroupés par ressource — voir Routes & CRUD. |
| Serveur | Servir le design comme un mock, en HTTP, GraphQL, SOAP, OData ou gRPC — voir Servir le design en mock. |
| Clients | Des requêtes prêtes à l’emploi qui appellent le mock en cours d’exécution — voir Clients. |
| Documentation & Notes | De la documentation et des notes libres attachées au design. |
| Code | La génération de code à partir de vos templates — voir Génération de code. |
Les réglages du design (nom, valeurs par défaut) s’ouvrent en cliquant directement sur le nœud du design dans la barre latérale.
Le parcours type
Section titled “Le parcours type”- Décrivez vos données — créez vos modèles et vos enums, ajoutez leurs propriétés, leurs types et leurs contraintes.
- Définissez vos routes — à la main, ou d’un clic avec Générer le CRUD depuis un modèle.
- Servez le mock — démarrez le serveur et pointez votre application ou un client dessus. Le même design est projeté automatiquement dans chaque protocole activé.
- Générez le code — choisissez un ou plusieurs templates (les vôtres ou ceux proposés par Restorm) et produisez le projet correspondant.
Chaque étape est détaillée dans les pages de cette section.