Passer au contenu principal
Des 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 de l’API Mintlify. Les extraits d’utilisation de 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 et 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 Speakeasy Dashboard 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 avec un carré rouge et le numéro 1, et l’entrée de l’API est mise en évidence avec un carré rouge et le numéro 2.
Si l’entrée n’est pas indiquée comme Combined Spec, assurez-vous que l’API dispose d’une URL de génération automatique d’exemples de code configurée.
Depuis la page de l’entrée du registre, copiez l’URL publique fournie.
Capture d’écran montrant l’entrée de registre de la spécification combinée avec la fonction de copie de l’URL mise en évidence par un carré rouge.

​
Mettre à 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 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 testés dans l’aire de jeu.
⌘I