Passer au contenu principal
Les extraits de code générés automatiquement à partir des SDK Speakeasy peuvent être intégrés directement dans la documentation de référence d’API de Mintlify. Des exemples d’utilisation des SDK s’affichent dans le bac à sable interactif des sites de documentation propulsés par Mintlify.
Un bac à sable d’API Mintlify avec des extraits de code Speakeasy.

​
Prérequis

Pour intégrer Mintlify à Speakeasy, vous aurez besoin des éléments suivants :

​
Configuration de l’intégration

Pour intégrer Speakeasy à Mintlify, vous devez récupérer l’URL publique de la spécification combinée de l’API depuis le registre, puis mettre à jour votre fichier de configuration docs.json.

​
Récupérer l’URL publique de la spécification combinée de l’API depuis le registre

Accédez à votre Dashboard Speakeasy et ouvrez l’onglet API Registry. Ouvrez l’entrée *-with-code-samples de l’API.
Capture d’écran de la page Speakeasy API Registry. L’onglet API Registry est mis en évidence par un carré rouge avec le numéro 1 et l’entrée de l’API est mise en évidence par un carré rouge avec le numéro 2.
Si l’entrée n’est pas étiquetée Combined Spec, vérifiez que l’API a une URL d’exemples de code automatisée configurée.
Depuis la page de l’entrée du registre, copiez l’URL publique fournie.
Capture d’écran montrant l’entrée du registre de la spécification combinée avec la fonction de copie d’URL mise en évidence par un carré rouge.

​
Mettez à jour votre fichier de configuration docs.json

Ajoutez l’URL de la spécification combinée dans une section Anchors ou Tabs de votre fichier docs.json. Ajoutez l’URL de la spécification combinée à une ancre en mettant à jour le champ anchor dans votre fichier docs.json comme suit :
docs.json
{
  "anchors": [
    {
      "name": "Référence de l'API",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL",
      "url": "api-reference",
      "icon": "square-terminal"
    }
  ]
}
Ajoutez l’URL de la spécification combinée à un onglet en mettant à jour le champ tab dans le fichier docs.json comme suit :
docs.json
{
  "tabs": [
    {
      "name": "Référence de l'API",
      "url": "api-reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL"
    }
  ]
}
Les extraits de code générés par Speakeasy peuvent désormais être affichés dans votre documentation d’API et utilisés dans l’aire de jeu.