Constructeur d'API avec FastAPI

Guide complet pour concevoir, construire, tester, empaqueter et déployer des API REST avec Python et FastAPI. Utilisez-le chaque fois qu'un utilisateur souhaite créer, concevoir, construire, exposer ou déployer une API, un backend, un service web, un endpoint, un webhook, ou convertir un script/processus en service invocable par des bots RPA, Automation Anywhere, des applications ou des fronts, même s'il ne mentionne pas FastAPI ou le déploiement.

Qu'est-ce que Constructeur d'API avec FastAPI ?

Ce skill est un assistant complet pour les développeurs qui souhaitent créer des API REST avec Python et FastAPI, du concept initial jusqu'au déploiement en production. Il guide l'utilisateur à travers six phases structurées : comprendre les besoins, concevoir l'architecture, construire le code, tester, empaqueter et déployer. Il prend en charge plusieurs plateformes de déploiement (VPS Docker, PaaS comme Render ou Railway, et solutions cloud comme Cloud Run). Le skill interroge l'utilisateur uniquement sur les choix critiques (persistance, authentification, destination) et assume des valeurs par défaut raisonnables pour le reste. Il génère du code modulaire, utilise Pydantic pour la validation, inclut des tests avec pytest, propose un Dockerfile prêt pour la production, et vérifie le bon fonctionnement via des appels curl après le déploiement.

Compatible avec✓Claude Code~Codex CLI~Cursor
Part ofMobile
npx skills add https://github.com/EstefaniaRojasal-design/Skills/tree/main/fastapi-api-builder

Installed? Explore more Développement et programmation skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Constructeur d'API avec FastAPI : de la conception au déploiement

Guide l'utilisateur à travers six phases : comprendre → concevoir → construire → tester → empaqueter → déployer. Ne pose que des questions qui changent le résultat, assume le reste en déclarant les suppositions et construit sans demander d'approbation phase par phase.

Responsabilités et limites

  • Génère et teste le code dans l'environnement disponible.
  • Le déploiement réel est exécuté par l'utilisateur sur son compte ou serveur, car l'assistant n'y a généralement pas accès. Fournit des commandes exactes et des étapes de vérification.
  • Si l'environnement a accès au serveur ou à la CLI de la plateforme, par exemple Claude Code, exécute les actions uniquement avec la confirmation nécessaire de l'utilisateur.
  • N'affirme pas avoir exécuté des tests ou des déploiements qui n'ont pas pu être réalisés.

Phase 1 : Comprendre (un tour de questions clés)

Avant d'écrire du code, clarifie ce qui change l'architecture. S'il existe un outil de questions avec options cliquables (ask_user_input_v0), utilise-le ; sinon, fais une courte liste. Maximum trois ou quatre questions et omet celles déjà répondues :

  1. But et ressources : que fait l'API, sur quelles entités opère-t-elle (par exemple clients, factures, commandes) et de quelles opérations a-t-elle besoin ?
  2. Persistance : sans base de données, SQLite (prototype) ou PostgreSQL ?
  3. Consommateur et accès : qui l'appelle (bot RPA/Automation Anywhere, application web, autre service) et doit-elle être publique ou interne ? Cela détermine l'authentification et le déploiement.
  4. Destination : si elle est déjà connue, utilise-la ; sinon, présente les options de la Phase 6 et recommande-en une sans bloquer la construction.

Pour le reste, assume des valeurs raisonnables (FastAPI, clé API, format d'erreur uniforme, pytest, Docker) et déclare-les en une ligne.

Phase 2 : Concevoir

Avant de construire, présente une conception compacte pour que l'utilisateur puisse la corriger ; s'il confirme ou ne s'y oppose pas, passe à la construction :

  • Tableau des endpoints : méthode, chemin, fonction et codes de réponse.
  • Modèles d'entrée/sortie : champs et validations.
  • Authentification choisie et justification ; consulte references/auth.md s'il existe.

Conventions REST : noms au pluriel (/clients), verbes HTTP pour l'action, 201 à la création, 204 à la suppression, 404 si inexistant, 422 pour données invalides et 401 sans identifiants.

Phase 3 : Construire

S'ils sont disponibles, copie le modèle testé via le squelette plutôt que de tout réécrire :

python <chemin-du-skill>/scripts/scaffold.py "<nom-du-projet>" --out /home/claude

Adapte le modèle à la conception :

  • Remplace la ressource exemple app/routers/items.py et app/schemas.py par les ressources requises.
  • Enregistre les routeurs dans app/main.py avec include_router.
  • Ajuste app/config.py et .env.example pour les nouvelles variables.
  • S'il y a une base de données, consulte references/database.md s'il existe.
  • Si l'authentification utilisateur est nécessaire, consulte references/auth.md s'il existe.
  • Si le consommateur est Automation Anywhere, consulte references/aa-integration.md s'il existe et applique son contrat : codes HTTP clairs, JSON avec status et messages utiles.

N'invente pas de fichiers de modèle ou de références qui ne sont pas disponibles. S'ils n'existent pas, crée explicitement une solution équivalente.

La structure en couches (routeurs, schémas, configuration, sécurité) facilite la croissance ; Pydantic valide les données avant la logique ; des gestionnaires globaux renvoient des erreurs uniformes comme {"status":"error","message":"..."} sans filtrer les détails internes dans les erreurs 500. Inclus /health pour Docker, les équilibreurs de charge et les plateformes. Configure via des variables d'environnement : même code en local et en production, secrets hors du dépôt.

Phase 4 : Tester

Exécute toujours avant de livrer et corrige les échecs jusqu'à ce qu'ils passent, lorsque l'environnement le permet :

cd <projet> && pip install -r requirements-dev.txt && python -m pytest -q

Ajoute des tests pour chaque nouvel endpoint : cas nominal, donnée invalide, ressource introuvable et sans authentification le cas échéant. Si possible, démarre le serveur réel (uvicorn app.main:app --port 8000) et vérifie avec curl /health, endpoint protégé avec et sans clé, et /docs. Si un test ne peut pas être exécuté, explique pourquoi et ce qui manque.

Phase 5 : Empaqueter

  • Le Dockerfile doit s'exécuter en tant qu'utilisateur sans privilèges et écouter sur $PORT, pour fonctionner de la même manière sur Render, Railway, Cloud Run et VPS.
  • .dockerignore et .gitignore doivent exclure .env ; vérifie qu'il n'y a pas de secrets dans le code ni dans les fichiers livrés.
  • Livre le projet complet compressé dans /mnt/user-data/outputs/ avec present_files, si ces outils sont disponibles. Sinon, fournis la structure et les fichiers de manière utile, sans affirmer qu'un ZIP a été créé.
  • Inclus un résumé bref : comment exécuter localement, variables d'environnement nécessaires et endpoints.

Liste pré-production

  • API_KEY (ou JWT) définie avec une valeur longue et aléatoire, stockée comme secret sur la plateforme.
  • CORS_ORIGINS avec une liste explicite, pas *.
  • ENVIRONMENT=production.
  • Base de données persistante et avec sauvegardes ; ne pas utiliser SQLite sur un disque éphémère.
  • HTTPS actif ; ne jamais exposer une clé API via HTTP.
  • .env hors du dépôt.
  • Tests réussis et /health répondant.
  • Logs accessibles et alerte en cas d'erreurs 5xx.

Phase 6 : Déployer

Si l'utilisateur n'a pas choisi de destination, présente cette comparaison et recommande selon son cas. S'il a peu d'expérience en infrastructure, PaaS ; s'il nécessite un réseau interne ou un contrôle total, VPS/serveur dédié ; si l'entreprise utilise déjà un cloud, conteneur géré sur ce cloud.

OptionEffortContrôleCoût typiqueMeilleur pour
Docker sur VPS ou serveur dédiéMoyenTotalFixe et faibleRéseau interne, contrôle, coût prévisible
PaaS (Render, Railway, Fly.io)FaibleMoyenFaible à moyen, à l'usageSortie rapide, petites équipes
Cloud (Cloud Run, Container Apps, App Runner/ECS)Moyen à élevéÉlevéÀ l'usageEntreprises avec cloud, mise à l'échelle, conformité

Après avoir choisi, consulte uniquement le guide correspondant, s'il existe :

  • references/deploy-vps-docker.md
  • references/deploy-paas.md
  • references/deploy-cloud.md

Les commandes et les écrans des plateformes externes changent. Si l'utilisateur indique que l'interface ne correspond pas, consulte la documentation en vigueur plutôt que d'insister avec des instructions obsolètes.

Termine par une vérification post-déploiement :

curl https://<url>/health

Ouvre /docs, teste un endpoint avec et sans clé (sans clé, il doit répondre 401) et vérifie les logs. En cas d'échec, demande l'erreur ou les logs et diagnostique. Problèmes courants : port incorrect (l'application doit écouter sur $PORT), variable d'environnement manquante, postgres:// au lieu de postgresql://, ou CORS bloquant le frontend.

Format de livraison finale

Reste bref et utile et inclus :

  1. Ce qui a été construit et les suppositions faites.
  2. Commandes pour exécuter localement.
  3. Variables d'environnement requises.
  4. Tableau des endpoints.
  5. Prochaines étapes du déploiement choisi.

Évite de répéter inutilement le contenu des fichiers.

Skills associés