3.2 KiB
Général - Guides pratiques - Recettes
Voici plusieurs renvois vers d'autres endroits de la documentation, 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 la documentation Tutoriel - Modèle de réponse - Type de retour{.internal-link target=_blank}.
Étiquettes de documentation - OpenAPI
Pour ajouter des étiquettes à vos chemins d'accès et les regrouper dans l'interface utilisateur de la documentation, lisez la documentation Tutoriel - Configurations de chemin d'accès - Tags{.internal-link target=_blank}.
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 la documentation Tutoriel - Configurations de chemin d'accès - Résumé et description{.internal-link target=_blank}.
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 la documentation Tutoriel - Configurations de chemin d'accès - Description de la réponse{.internal-link target=_blank}.
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 la documentation Tutoriel - Configurations de chemin d'accès - Déprécier un chemin d'accès{.internal-link target=_blank}.
Convertir n'importe quelles données au format compatible JSON
Pour convertir des données vers un format compatible JSON, lisez la documentation Tutoriel - Encodeur compatible JSON{.internal-link target=_blank}.
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 la documentation Tutoriel - Métadonnées et URLs de la documentation{.internal-link target=_blank}.
URL OpenAPI personnalisée
Pour personnaliser l'URL OpenAPI (ou la supprimer), lisez la documentation Tutoriel - Métadonnées et URLs de la documentation{.internal-link target=_blank}.
URL de la documentation OpenAPI
Pour mettre à jour les URL utilisées pour les interfaces utilisateur de documentation générées automatiquement, lisez la documentation Tutoriel - Métadonnées et URLs de la documentation{.internal-link target=_blank}.