Exposer un contrat d’API défini
Créer jusqu’à 3 endpoints REST simples pour lire, créer, modifier ou supprimer une ressource selon un comportement convenu.
Service Python et FastAPI
Créer une API REST Python documentée avec FastAPI
Cette page vous aide à vérifier si le service correspond aux endpoints, aux données, aux règles métier et aux contraintes d’intégration de votre projet avant de poursuivre sur ComeUp.
Voir la prestation sur ComeUpQuand ce service est adapté
La prestation convient à une API dont le contrat, les entrées, les sorties et les règles peuvent être définis avant le développement.
Ajouter un backend à une application
Fournir à une application web, mobile ou métier des routes HTTP structurées lorsque les échanges attendus sont déjà identifiés.
Préparer une intégration documentée
Valider les données avec Pydantic, gérer les erreurs HTTP et rendre le contrat consultable dans la documentation Swagger/OpenAPI.
Ce que vous recevez
Le service de base reste aligné sur le périmètre commercial actuellement publié sur ComeUp.
- Le code source complet d’une application FastAPI comprenant jusqu’à 3 endpoints REST simples
- La validation des données, la gestion des erreurs HTTP et la documentation Swagger/OpenAPI
- Un fichier README avec les instructions d’installation et de lancement, des tests essentiels et une série de corrections après livraison
Ce qu’il faut préparer
Un contrat précis permet de vérifier le périmètre et les contraintes d’intégration avant de commencer.
- La liste des endpoints attendus, leurs méthodes HTTP et leur objectif
- Des exemples anonymisés des données d’entrée et de sortie, avec les règles métier et les erreurs à gérer
- Le contexte de l’application existante, l’environnement technique et les contraintes d’intégration utiles
Ce qui nécessite un périmètre séparé
Le service de base se concentre sur une petite API documentée. Les fonctions qui modifient l’architecture, la sécurité ou l’exploitation doivent être confirmées séparément sur ComeUp.
Non inclus dans le service de base
- Une base PostgreSQL ou MySQL, des modèles SQLAlchemy, des migrations Alembic et des routes CRUD reliées à la base nécessitent l’option correspondante
- L’authentification JWT et les rôles nécessitent l’option correspondante ; OAuth et SSO ne sont pas inclus
- Docker, des tests supplémentaires et le déploiement nécessitent l’option correspondante ; les frais d’hébergement et la maintenance ne sont pas inclus
- La conception d’une interface web ou mobile complète n’entre pas dans cette prestation d’API