Speakeasy

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.

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

• Un référentiel de documentation Mintlify.
  • Un SDK généré par Speakeasy avec une URL d’exemples de code automatisés configurée.

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.

Accédez à votre Dashboard Speakeasy et ouvrez l’onglet API Registry. Ouvrez l’entrée *-with-code-samples de l’API.

Depuis la page de l’entrée du registre, copiez l’URL publique fournie.

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 :

{
  "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 :

{
  "tabs": [
    {
      "name": "Référence de l'API",
      "url": "api-reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL"
    }
  ]
}

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.

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.