Scrivere un riferimento API utilizzabile subito
Prompt che trasforma codice ed esempi in un riferimento per endpoint con codici di errore e chiamate funzionanti. Lo copi nello strumento di IA che preferisce, che poi scrive il riferimento API.
- Tema
- App e prototipi
- Tipo
- Prompt
- Livello
- Intermedio
- Tempo
- circa 10 min
I risultati dipendono dallo strumento, dal modello e da ciò che inserisce.
Anteprima del risultato
Esempio: scritto dalla nostra redazione, non è una vera risposta dell'IA.
## POST /ordini Crea un ordine. | Campo | Tipo | Obbligatorio | Nota | | cliente_id | testo | sì | da GET /clienti | | righe | elenco | sì | almeno 1 | | coupon | testo | no | maiuscolo | Errori: 409 = coupon già usato → reinviare senza coupon Domanda aperta: il limite di 100 chiamate al minuto vale per chiave o per account?
Compili
Ciò che scrive resta in questa finestra del browser. Non salviamo né inviamo nulla.
- API REST di un negozio online
- API interna tra due servizi
- API per aziende partner
- API di webhook
- API GraphQL
- codice sorgente delle rotte
- un file OpenAPI esistente
- una raccolta di chiamate di esempio
- vecchia documentazione in testo
- solo appunti del team
- team di sviluppo dei clienti
- nuove persone del proprio team
- aziende partner senza conoscenze pregresse
- team di assistenza
- team frontend interno
Il suo prompt
Ha modificato il prompt. Le modifiche nei campi sopra non lo sovrascrivono più.
Questa è un'istruzione per un'IA, non ancora il risultato.
Dove funziona questo prompt
Questi strumenti di IA sono adatti a questo prompt:
Come usarlo
- Compili i campi o tocchi un suggerimento. Non inserisca nomi, indirizzi o altri dati personali.
- Copi il prompt completo nello strumento di IA che preferisce.
- Dia solo il riferimento a qualcuno che non conosce l'API. Se riesce a fare la prima chiamata senza chiedere nulla, il riferimento è buono.
Perché funziona?
I riferimenti falliscono di rado per endpoint mancanti, piuttosto per codici di errore assenti, campi obbligatori poco chiari ed esempi che non funzionano. Una struttura fissa per endpoint e domande aperte invece di risposte inventate li rendono affidabili.
Consigli
- Sostituisca chiavi, token e dati dei clienti negli esempi con segnaposto prima di inserire materiale nello strumento di IA.