Speakeasy

Automatisieren Sie Ihre SDK-Beispielsnippets in der API-Spielwiese

Automatisch generierte Codebeispiele aus Speakeasy-SDKs lassen sich direkt in die Mintlify-API-Referenz integrieren. SDK-Beispielsnippets werden in der interaktiven API-Spielwiese von Mintlify-basierten Dokumentationsseiten angezeigt.

Voraussetzungen

Um Mintlify in Speakeasy zu integrieren, benötigen Sie Folgendes:

• Ein Mintlify-Dokumentations-Repository.
  • Ein von Speakeasy generiertes SDK mit einer konfigurierten URL für automatisierte Codebeispiele.

Einrichten der Integration

Um Speakeasy in Mintlify zu integrieren, müssen Sie die öffentliche URL der kombinierten API-Spezifikation aus dem Registry abrufen und Ihre docs.json-Konfigurationsdatei aktualisieren.

Öffentliche URL der kombinierten API-Spezifikation aus der Registry abrufen

Navigieren Sie zu Ihrem Speakeasy-Dashboard und öffnen Sie den Tab API Registry. Öffnen Sie den Eintrag *-with-code-samples für die API.

Wenn der Eintrag nicht mit Combined Spec gekennzeichnet ist, stellen Sie sicher, dass für die API eine automatische Codebeispiel-URL konfiguriert ist.

Kopieren Sie auf der Seite des Registry-Eintrags die angegebene öffentliche URL.

Aktualisieren Sie Ihre docs.json-Konfigurationsdatei

Fügen Sie die kombinierte Spec-URL in Ihrer docs.json-Datei einem Abschnitt Anchors oder Tabs hinzu.

Fügen Sie die kombinierte Spec-URL einem Anchor hinzu, indem Sie das Feld anchor in Ihrer docs.json-Datei wie folgt aktualisieren:

docs.json

{
  "anchors": [
    {
      "name": "API Reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL",
      "url": "api-reference",
      "icon": "square-terminal"
    }
  ]
}

Fügen Sie die kombinierte Spec-URL einem Tab hinzu, indem Sie das Feld tab in der docs.json-Datei wie folgt aktualisieren:

docs.json

{
  "tabs": [
    {
      "name": "API Reference",
      "url": "api-reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL"
    }
  ]
}

Von Speakeasy generierte Codebeispiele können jetzt in Ihrer API-Dokumentation angezeigt und in der API-Spielwiese verwendet werden.