Skip to main content
Vous pouvez intégrer les extraits de code générés automatiquement à partir des SDK Speakeasy directement dans la documentation de référence d’API de Mintlify. Les exemples d’utilisation des SDK apparaissent 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. Un carré rouge avec le numéro 1 met en évidence l’onglet API Registry, et un carré rouge avec le numéro 2 met en évidence l’entrée de l’API.
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
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
Vous pouvez désormais afficher les extraits de code générés par Speakeasy dans votre documentation d’API et interagir avec eux dans le playground.

​
Vérifier l’intégration

Après avoir redéployé votre documentation, ouvrez n’importe quel endpoint dans votre référence d’API et vérifiez que les extraits de code apparaissent dans le playground. L’ensemble des langages disponibles correspond aux cibles SDK configurées dans votre projet Speakeasy. Si les extraits n’apparaissent pas, vérifiez que :
  • L’URL openapi dans docs.json pointe vers l’entrée de spécification combinée *-with-code-samples, et non vers le fichier OpenAPI source.
  • L’URL de la spécification combinée est accessible publiquement depuis le navigateur.
  • Votre projet Speakeasy dispose d’une URL d’échantillons de code automatisés configurée et d’au moins une cible SDK activée.