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.

Prérequis

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.

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.

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.

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"
    }
  ]
}

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.

Prise en main

Organiser

Personnaliser

Créer du contenu

Documenter des API

Déployer

Optimisation

Prérequis

Configuration de l’intégration

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

Mettez à jour votre fichier de configuration `docs.json`

​Prérequis

​Configuration de l’intégration

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

​Mettez à jour votre fichier de configuration docs.json

Prérequis

Configuration de l’intégration

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

Mettez à jour votre fichier de configuration `docs.json`