Speakeasy

Automatizza gli snippet di utilizzo dell’SDK nell’API playground

Gli snippet di codice generati automaticamente dagli SDK di Speakeasy possono essere integrati direttamente nella documentazione di riferimento API di Mintlify. Gli snippet di utilizzo dell’SDK vengono mostrati nel playground interattivo dei siti di documentazione basati su Mintlify.

Prerequisiti

Per integrare Mintlify con Speakeasy, ti serviranno:

• Un repository della documentazione Mintlify.
  • Un SDK generato da Speakeasy con un URL per esempi di codice automatizzati configurato.

Configurare l’integrazione

Per integrare Speakeasy con Mintlify, devi recuperare dall’apposito registry l’URL pubblico della specifica combinata dell’API e aggiornare il file di configurazione docs.json.

Ottieni l’URL pubblico della specifica combinata dell’API dal registro

Vai alla tua Dashboard di Speakeasy e apri la scheda API Registry. Apri la voce *-with-code-samples dell’API.

Se la voce non è etichettata Combined Spec, assicurati che per l’API sia configurato un URL automatico per gli esempi di codice.

Dalla pagina della voce nel registro, copia l’URL pubblico fornito.

Aggiorna il file di configurazione docs.json

Aggiungi l’URL della specifica combinata a una sezione Anchors o Tabs nel file docs.json.

Per aggiungere l’URL della specifica combinata a un anchor, aggiorna il campo anchor nel file docs.json come segue:

docs.json

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

Per aggiungere l’URL della specifica combinata a una tab, aggiorna il campo tab nel file docs.json come segue:

docs.json

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

Gli snippet di codice generati da Speakeasy sono ora visibili nella documentazione API e interattivi nell’API playground.