Guides pratiques

Ces guides vous montrent comment accomplir des tâches spécifiques avec Flask-Jeroboam. Chaque guide répond à un besoin du monde réel et fournit des exemples pratiques que vous pouvez appliquer à votre propre code.

Contenu :

• Comment valider les données de requête
  • Paramètres scalaires simples
  • Paramètres de requête vs body
  • Utiliser des modèles Pydantic
  • Contraintes de champ
  • Paramètres de chemin
  • En-têtes et cookies
  • Validation conditionnelle
  • Champs optionnels
• Comment sérialiser les réponses
  • Modèles de réponse simples
  • Listes et collections
  • Alias de champ
  • Exclure les champs
  • Réponses imbriquées
  • Réponses optionnelles
  • Coercition de type
  • Champs calculés
  • Sérialiseurs personnalisés
• Comment personnaliser la documentation de l’API
  • Ajouter des descriptions
  • Documenter les paramètres
  • Descriptions de réponse
  • Personnaliser les endpoints
  • Grouper les endpoints avec des tags
  • Masquer les endpoints des documents
  • Documenter les erreurs
  • Authentification dans les documents
  • Exemples dans les documents
  • Déprécier les endpoints
• Comment configurer Flask-Jeroboam
  • Désactiver la documentation OpenAPI
  • Personnaliser l’URL des documents
  • Changer le titre OpenAPI
  • Désactiver les gestionnaires d’erreurs automatiques
  • Validation des réponses
  • Utiliser avec le modèle application factory
  • Configuration avec des variables d’environnement
  • Réponses d’erreur personnalisées
  • En-têtes de réponse
  • Mise en cache des réponses
  • Configuration CORS
  • Journalisation et débogage
  • Réglage des performances