Configurez les spécifications OpenAPI et AsyncAPI, le playground API interactif, les exemples de code SDK et les paramètres d’authentification dans votre fichier docs.json.
Utilisez le champ api dans docs.json pour configurer les spécifications d’API qui génèrent les pages d’API, le playground d’API interactif pour tester les endpoints, et comment générer et afficher les exemples de code.
Fichiers de spécification OpenAPI pour générer des pages de référence d’API. Accepte un chemin ou une URL unique, un tableau de chemins et d’URL, ou un objet spécifiant une source et un répertoire.
Fichiers de spécification AsyncAPI pour générer des pages de référence d’API événementielles. Accepte un chemin ou une URL unique, un tableau de chemins et d’URL, ou un objet spécifiant une source et un répertoire.
Indique s’il faut inclure les cookies et les en-têtes d’authentification pour les requêtes cross-origin lorsque proxy est false. Valeur par défaut : false. N’a aucun effet lorsque proxy est true.
Clés de champs de la spécification OpenAPI à faire apparaître sous forme de pastilles post à côté du nom de chaque paramètre dans les pages de référence d’API et dans le playground. Pour chaque clé que vous listez, Mintlify lit la valeur depuis le schéma et l’affiche sous forme de pastille :
Les valeurs de chaîne sont affichées telles quelles.
true affiche le nom de la clé comme libellé de la pastille. false, null et les chaînes vides n’affichent rien.
Les valeurs numériques sont affichées sous forme de chaîne.
Les tableaux de chaînes ou de nombres affichent une pastille par élément.
Les objets et les autres valeurs sont ignorés.
Utilisez ceci pour exposer des champs OpenAPI personnalisés — tels que x-internal, nullable ou des extensions de fournisseur — sous forme d’annotations visuelles sur chaque paramètre, sans configuration propriété par propriété.
Mode d’affichage de l’URL de base dans l’en-tête de l’endpoint. Définissez sur full pour toujours afficher l’URL de base complète sur chaque page d’endpoint. Par défaut, l’URL de base n’est affichée que lorsqu’il y a plusieurs URL de base parmi lesquelles choisir.
Indique s’il faut générer des exemples de code pour les endpoints à partir de votre spécification d’API. Valeur par défaut : true. Lorsque défini sur false, seuls les exemples de code écrits manuellement (à partir de x-codeSamples dans OpenAPI ou des composants <RequestExample> dans MDX) apparaissent dans le playground.
URL de base ajoutée en préfixe aux chemins relatifs dans les champs frontmatter api au niveau de la page. Non utilisée lorsque le frontmatter contient une URL complète.
