Comment créer et déployer une API REST avec l’IA sur Adios
Un créateur de backend avec l’IA vous aide à définir et générer les routes, les données, la validation, les tests et la configuration d’exécution de votre application. Ce guide explique comment utiliser l’agent IA Adios pour créer et déployer ce backend, et non comment appeler l’API d’un modèle d’IA.
↗ Validez la requête puis confirmez ensemble le mouvement et le stock.
↳ GET /inventory?product_id=MUG-01
02Relisez le résultat persistant.
01Authorization: Bearer <test-token>
02200 OK
03{"product_id":"MUG-01","stock":10}
↗ Une nouvelle requête doit retrouver le même état enregistré.
↳ POST /movements
03Rendez les entrées invalides prévisibles.
01{"product_id":"MUG-01","quantity":"two"}
02422 Unprocessable Content
03{"error":"invalid_quantity"}
↗ Renvoyez une erreur utile sans modifier le stock.
↳ POST /movements · même opération
04Ne déduisez pas le stock deux fois.
01Idempotency-Key: shipment-42
02200 OK · existing result
03{"movement_id":"mv_42","stock":10}
↗ La clé de nouvelle tentative doit être contrôlée et persistée côté serveur.
L’exemple est une API de gestion de stock avec produits, mouvements de stock et inventaire actuel. Son périmètre reste assez réduit pour être vérifié, tout en permettant de valider les requêtes, les écritures en base, les limites d’authentification, la gestion des erreurs et les contrôles de santé. Explorer Guides de création de projets complets avec l’IA.
Exemple pratique / API de stock
Écrivez les exemples que votre API doit respecter.
Les requêtes simulées illustrent un contrat : retirer deux tasses fait passer le stock de douze à dix. Une entrée invalide ne change rien ; répéter l’opération renvoie son résultat initial. Donnez ces exemples à l’IA avant de générer les gestionnaires.
ADIOS / Suivez une requête APIExemple illustratif
POST/movementsIdempotency-Key: shipment-42
Requête du clientProduit + quantité{"product_id":"MUG-01","quantity":-2}
Vérifier l’identitéJeton + droits sur la ressource
Valider l’entréeTypes · limites · stock
Une transactionEnregistrer le mouvement + mettre à jour le stock
Postgres / inventoryDonnées d’exemple
Relire l’état enregistré
product_id
Avant
Après
MUG-01
12
10
Même clé réutilisée → le stock reste à 10.
Réponse
201 Created
{
"movement_id": "mv_42",
"stock": 10
}
401 / 403422409
Définissez les réponses d’erreur avant de générer les gestionnaires.
01
Rendez les changements de stock atomiques.
Enregistrez le mouvement et ajustez le stock dans une transaction. Testez deux requêtes simultanées sur le dernier article disponible. Une lecture suivie d’une écriture non protégée peut dépasser le stock, même si chaque requête passe la validation seule.
02
Traitez les nouvelles tentatives comme du trafic normal.
Un appel peut expirer après l’enregistrement côté serveur. Stockez une clé d’opération avec le résultat et refusez sa réutilisation avec d’autres données. Un indicateur en mémoire dans le navigateur ne protège pas l’API contre les nouvelles tentatives d’un autre client ou processus.
03
Documentez les échecs comme les réussites.
Précisez l’authentification, la propriété des ressources, les erreurs, la pagination et les limites de requêtes. Ajoutez des requêtes exécutables et des réponses types. Avant de renommer un champ ou de changer son type, pensez aux clients existants.
Les codes et données ci-dessus illustrent un choix de conception. Alignez le code, les tests et la documentation sur votre contrat ; une documentation générée ne prouve pas qu’un gestionnaire se comporte correctement.
Comparez le démarrage, le port, les contrôles de santé, les migrations, les dépendances, les secrets et les tests de bon fonctionnement avec adios.yaml.
Publiez la version vérifiée et refaites les contrôles de santé, d’authentification et les tests d’écriture et de lecture.
Exemple de projet / Stockroom API
Un backend sur lequel une autre application peut s’appuyer
Le résultat dispose d’un contrat documenté et d’une gestion des échecs prévisible. Une liste d’endpoints sans validation, tests ni configuration d’exécution n’est pas une API terminée.
Indiquez la santé du processus sans exposer de données privées.
00
Avant de rédiger votre prompt
Rédigez le contrat avant de générer des gestionnaires
Commencez par les utilisateurs de l’API et les ressources. L’IA comprend ainsi la raison de chaque route, champ, code de statut et autorisation, au lieu de produire une API CRUD générique.
ENTRÉE / 01
Utilisateur de l’API identifié
Identifiez l’application web, l’application mobile, l’outil interne ou le partenaire qui appellera l’API.
ENTRÉE / 02
Propriété des ressources
Précisez si les données sont publiques ou appartiennent à un utilisateur, une équipe ou un service.
ENTRÉE / 03
Contrat de gestion des erreurs
Avant l’implémentation, choisissez un format JSON d’erreur unique et sans données sensibles, ainsi que des codes de réponse pertinents.
ENTRÉE / 04
Éléments de vérification d’exécution
Conservez ensemble les exigences de démarrage, de port, de santé, de base de données, de secrets, de migration et de tests de bon fonctionnement.
Demander les routes, les données, les autorisations et les tests avant le code
Ce prompt demande à l’agent d’examiner la stack existante et de présenter d’abord le contrat de l’API. Remplacez les valeurs entre crochets et examinez la réponse comme document de cadrage de l’API.
Prompt de planification de l’API
Aidez-moi à planifier une API REST conçue pour la production dans cet espace de travail Adios. Ne modifiez pas encore les fichiers.
L’API :
- Nom : [NOM DE L’API]
- Utilisateur : [APPLICATION WEB, APPLICATION MOBILE, OUTIL INTERNE OU PARTENAIRE]
- Ressource principale : [RESSOURCE]
- Actions principales : [CRÉER, LISTER, LIRE, MODIFIER OU AUTRES ACTIONS]
- Authentification : [AUCUNE POUR UNE DÉMO PUBLIQUE, JETON UTILISATEUR OU CLÉ API DE SERVICE]
- Base de données : [BASE DE DONNÉES ACTUELLE DU PROJET OU POSTGRES]
Avant de proposer des modifications, examinez le dépôt, le framework actuel, le gestionnaire de packages, les tests, la route de contrôle de santé, la configuration d’environnement et adios.yaml.
Présentez :
1. le tableau des routes avec les méthodes et les codes de réponse ;
2. les formats des requêtes et des réponses ;
3. la validation et la gestion des erreurs ;
4. le modèle de données et l’approche de migration ;
5. les périmètres d’authentification et d’autorisation ;
6. les considérations de limitation du débit et de prévention des abus ;
7. les tests automatisés et les exemples curl manuels ;
8. la configuration Adios requise pour l’environnement d’exécution, la santé, la base de données et les secrets.
Privilégiez la stack existante. Expliquez toute nouvelle dépendance. Attendez mon approbation avant toute modification.
Ce qu’une réponse utile doit contenir
Un tableau des routes plutôt qu’une liste de fonctionnalités souhaitées
Formats des requêtes, des réponses, de la validation et des erreurs
Un modèle explicite de propriété et d’autorisation
Exigences d’exécution et de test avant toute modification
02
Mettre en œuvre le contrat
Créer l’API en conservant la stack opérationnelle
Après avoir approuvé le contrat, utilisez ce prompt pour le mettre en œuvre avec des erreurs cohérentes, des accès paramétrés aux données, des tests et des exemples exécutables.
Prompt de création de l’API
Créez l’API REST à partir du plan que j’ai approuvé.
Exigences :
- Conservez le langage, le framework, le gestionnaire de packages et les fichiers de déploiement Adios existants.
- Préservez un endpoint léger de contrôle de santé, accessible sans authentification et n’exposant aucune donnée privée.
- Validez toutes les entrées externes et renvoyez les erreurs dans un format JSON unique et cohérent.
- Appliquez l’authentification et les autorisations côté serveur lorsque le plan l’exige.
- Utilisez des accès paramétrés à la base de données via la couche de données déjà établie dans le projet.
- Ajoutez des migrations réversibles si ce dépôt utilise des migrations.
- Ne codez jamais d’identifiants en dur. Référencez les valeurs de base de données et d’authentification par leur nom de variable d’environnement.
- Ajoutez une documentation concise de l’API et des exemples de requêtes exécutables.
- Ajoutez des tests pour le cas nominal, les entrées invalides, les enregistrements manquants, les accès non autorisés et un scénario d’échec de base de données testable sans risque.
- Exécutez le formateur, le linter, les tests et la commande de compilation de production déjà utilisés par le projet.
À la fin, donnez-moi le tableau des routes, les fichiers modifiés, les résultats des tests, la configuration Adios requise et les commandes exactes à exécuter sur l’aperçu. Ne déployez pas en production.
Ce qu’une réponse utile doit contenir
Gestionnaires conformes au tableau des routes approuvé
Validation et gestion des erreurs cohérentes
Tests de réussite, d’échec et de contrôle d’accès
Requêtes à copier pour l’aperçu
Dans la plateforme
Voyez les données derrière l’endpoint.
Utilisez l’explorateur de bases de données pour examiner les tables et lancer une requête. Cette démo Adios simulée montre une base privée, des exemples de retours clients et la connexion de l’application.
Tester les entrées mal formées, les limites d’accès et les requêtes répétées
Une requête qui réussit dans le cas nominal prouve peu de choses. Ce prompt de vérification teste le contrat du point de vue d’un client inconnu ou peu fiable.
Prompt de vérification de l’API
Examinez cette API comme si un client inconnu allait l’appeler. Corrigez uniquement les problèmes vérifiés et ne déployez pas.
Vérifiez :
- que les routes utilisent les méthodes HTTP et les codes de statut prévus ;
- que les entrées mal formées, manquantes, trop volumineuses ou inattendues sont rejetées sans risque ;
- que l’authentification ne peut pas être contournée et qu’un appelant ne peut pas accéder aux données protégées d’un autre ;
- que les réponses d’erreur n’exposent ni traces de pile, ni secrets, ni détails de base de données, ni chemins internes ;
- que les requêtes répétées restent sans risque lorsqu’une opération doit être idempotente ;
- que les écritures en base et les migrations sont cohérentes ;
- que la documentation de l’API et les exemples de requêtes correspondent à l’implémentation ;
- que les contrôles de santé restent légers ;
- que les journaux sont utiles sans enregistrer d’identifiants ni de corps de requête sensibles ;
- que tous les contrôles de formatage, de lint, de test et de compilation réussissent.
Présentez un tableau des contrôles et de leurs éléments de vérification, les requêtes exactes à exécuter dans l’aperçu et les risques restants.
Ce qu’une réponse utile doit contenir
Des tests d’échec, pas seulement des réponses 200
Pas de détails internes dans les erreurs publiques
Documentation vérifiée par rapport à la mise en œuvre
Une liste explicite des risques restants
04
Adapter l’exécution au code source
Comparer le contrat de l’API au contrat de mise en production Adios
Le dernier prompt vérifie que le code source, la migration, la commande de démarrage, le port, le chemin de contrôle de santé, les dépendances, les secrets et les tests de bon fonctionnement décrivent la même version.
Prompt de vérification de la mise en production de l’API
Préparez cette API pour une vérification de déploiement Adios. Ne déployez pas avant mon approbation.
Confirmez la commande de démarrage, l’hôte et le port d’écoute, le chemin de contrôle de santé, les noms des variables d’environnement requises, la dépendance à la base de données, la commande de migration et la route publique attendue. Comparez-les à adios.yaml et signalez toute divergence.
Donnez-moi ensuite :
1. les résultats finaux des contrôles automatisés ;
2. cinq requêtes de test de bon fonctionnement sans risque pour l’URL de l’aperçu ;
3. une note de retour arrière ou de restauration en cas de migration échouée ;
4. les secrets à configurer dans Adios plutôt que dans le code source ;
5. un contrôle après déploiement couvrant la santé, les journaux, l’authentification et un cycle d’écriture et de lecture.
Arrêtez-vous pour obtenir mon approbation avant le déploiement en production.
Ce qu’une réponse utile doit contenir
Pas d'inadéquation entre le processus et adios.yaml
Tests de bon fonctionnement sans risque dans l’aperçu et en production
Une note sur la restauration après migration
Une pause explicite avant le déploiement
T
Testez le résultat
Une compilation réussie marque le début de la vérification
Ouvrez l’aperçu et testez vous-même les parcours importants. Demandez des éléments de vérification à l’agent, mais ne confondez pas son compte rendu avec votre approbation.
ESSAI / 01
Contrat
Chaque route, méthode, code de statut et champ documenté correspond à l’implémentation.
Les entrées mal formées ou inattendues renvoient le même format JSON d’erreur, sans données sensibles.
La pagination, le filtrage et le tri se comportent de façon prévisible lorsqu’ils sont présents.
ESSAI / 02
Limite de confiance
Les identifiants manquants, invalides, expirés ou appartenant à un autre propriétaire sont rejetés sans risque.
Une erreur publique ne contient ni trace de pile, ni secret, ni détail SQL, ni chemin interne.
Les journaux excluent les identifiants et les corps de requête sensibles inutiles.
ESSAI / 03
Environnement d’exécution
Le processus écoute sur l'hôte et le port déclarés.
Les migrations, les contrôles de santé, le formatage, le lint, les tests et la compilation réussissent.
Un test d’écriture et de lecture réussit dans l’aperçu et après la mise en production.
Étape d’approbation humaine
Mettre en production le contrat de l’API avec ses éléments de vérification
Traitez le tableau des routes, les migrations, les noms des variables d’environnement, le chemin de contrôle de santé, les journaux et les requêtes de bon fonctionnement comme des éléments de la mise en production. N’approuvez que lorsqu’ils correspondent à la version qui fonctionne dans l’aperçu.
01Exécutez les requêtes sans risque dans l’aperçu et comparez-les à la documentation.
02Confirmez les instructions de migration et de restauration de la base de données pour cette version.
03Configurez les secrets nommés dans Adios et conservez leurs valeurs hors du code source.
04Vérifiez le démarrage, le port, la santé et les paramètres des dépendances dans adios.yaml.
05Approuvez la version, puis revérifiez la santé, l’authentification et un cycle d’écriture et de lecture.
?
Questions avant de commencer
Ce que ce guide promet, et ses limites
Ce guide crée-t-il une API d’IA ou mon API avec l’aide de l’IA ?+
Il utilise l’agent IA Adios pour créer le backend de votre application. L’API d’exemple gère les données de stock ; elle n’appelle aucun modèle de langage et n’expose aucune API de modèle d’IA.
Quel framework backend choisir ?+
Privilégiez le framework déjà utilisé dans le dépôt. Si vous partez de zéro, choisissez une stack que votre équipe peut maintenir, avec des conventions claires de validation, de test, de migration et d’exécution. Le prompt demande à l’agent d’expliquer toute nouvelle dépendance.
Un endpoint de contrôle de santé d’API doit-il nécessiter une authentification ?+
Un endpoint de contrôle de santé du processus est généralement léger et accessible sans authentification pour permettre à la plateforme de le vérifier. Il ne doit toutefois exposer ni secrets, ni données privées, ni identifiants de dépendances, ni détails internes de diagnostic.
Comment vérifier qu’une API générée par l’IA peut être déployée en toute sécurité ?+
Ne vous fiez pas uniquement à la génération. Examinez le contrat, exécutez les tests de réussite et d’échec, vérifiez les autorisations et les erreurs, inspectez la gestion des secrets, appliquez les migrations en toute sécurité, testez l’aperçu et approuvez vous-même la version candidate exacte.
Commencez par un espace de travail que vous pouvez examiner
Envoyez le premier prompt à Adios, puis approuvez le plan.