Prompt per tecnologia e sviluppo
Genera documentazione per API di livello Stripe: autenticazione, endpoint, errori e webhook, affinché gli sviluppatori possano autenticarsi, effettuare la prima chiamata e gestire un errore in meno di 10 minuti.
Questo prompt per generare documentazione per API AI crea documentazione allineata alle specifiche OpenAPI: panoramica, guida all'autenticazione, guida rapida, riferimento degli endpoint con esempi di codice in più linguaggi, gestione degli errori con relative soluzioni, limitazione della frequenza, webhook, SDK, criteri di versionamento e registro delle modifiche, nel formato usato dai responsabili della developer experience. Incollalo in Claude, ChatGPT o in qualsiasi chat AI, aggiungi la specifica della tua API e ottieni documentazione pronta per Docusaurus, ReadMe, Mintlify o GitBook.
L'autenticazione viene prima di tutto: uno sviluppatore che non riesce ad autenticarsi si arrende. Ogni risposta di errore è documentata con codice di stato, causa e soluzione (gli errori silenziosi sono vietati). Ogni endpoint include esempi completi e realistici di richieste e risposte in più linguaggi: i valori segnaposto "example_value_1" non sono accettabili. Funziona con Claude, ChatGPT o qualsiasi modello di chat AI.
Cosa ottieni
- Un prompt per generare documentazione per API AI pronto per la produzione (oltre 900 parole)
- Struttura completa della documentazione: panoramica, autenticazione, guida rapida, riferimento degli endpoint, errori, limiti di frequenza, webhook, SDK, registro delle modifiche
- Riferimento degli endpoint con esempi di codice in più linguaggi (cURL, Python, JavaScript, Go, Ruby - scegline 3-5)
- Tabella completa dei codici di errore: stato, codice, causa e come risolvere ogni errore
- Personalizzazione per API REST, GraphQL, ricche di webhook, enterprise/SOAP, solo interne e rivolte ai partner
Pensato per
Sviluppatori backend
Team della piattaforma
Relazioni con gli sviluppatori
Architetti tecnici
Ingegneri DX