3.4 KiB
Général - Guides pratiques - Recettes
Voici plusieurs renvois vers d'autres endroits dans les documents, pour des questions générales ou fréquentes.
Filtrer des données - Sécurité
Pour vous assurer que vous ne renvoyez pas plus de données que nécessaire, lisez les documents Tutoriel - Modèle de réponse - Type de retour.
Optimiser la performance des réponses - Modèle de réponse - Type de retour
Pour optimiser la performance lors du renvoi de données JSON, utilisez un type de retour ou un modèle de réponse ; de cette façon, Pydantic prendra en charge la sérialisation en JSON côté Rust, sans passer par Python. Pour en savoir plus, lisez les documents Tutoriel - Modèle de réponse - Type de retour.
Étiquettes de documentation - OpenAPI
Pour ajouter des étiquettes à vos chemins d'accès et les regrouper dans l'interface utilisateur de la documentation, lisez les documents Tutoriel - Configurations de chemin d'accès - Tags.
Résumé et description de la documentation - OpenAPI
Pour ajouter un résumé et une description à vos chemins d'accès et les afficher dans l'interface utilisateur de la documentation, lisez les documents Tutoriel - Configurations de chemin d'accès - Résumé et description.
Description de la réponse dans la documentation - OpenAPI
Pour définir la description de la réponse, affichée dans l'interface utilisateur de la documentation, lisez les documents Tutoriel - Configurations de chemin d'accès - Description de la réponse.
Déprécier un chemin d'accès dans la documentation - OpenAPI
Pour déprécier un chemin d'accès et l'indiquer dans l'interface utilisateur de la documentation, lisez les documents Tutoriel - Configurations de chemin d'accès - Dépréciation.
Convertir n'importe quelles données au format compatible JSON
Pour convertir des données vers un format compatible JSON, lisez les documents Tutoriel - Encodeur compatible JSON.
Métadonnées OpenAPI - Documentation
Pour ajouter des métadonnées à votre schéma OpenAPI, y compris une licence, une version, un contact, etc., lisez les documents Tutoriel - Métadonnées et URLs de la documentation.
URL OpenAPI personnalisée
Pour personnaliser l'URL OpenAPI (ou la supprimer), lisez les documents Tutoriel - Métadonnées et URLs de la documentation.
URL de la documentation OpenAPI
Pour mettre à jour les URL utilisées pour les interfaces utilisateur de documentation générées automatiquement, lisez les documents Tutoriel - Métadonnées et URLs de la documentation.