Redigere una descrizione API dalle rotte esistenti
Modello che trasforma rotte ed esempi esistenti in una bozza OpenAPI con un elenco di punti aperti. Lo copi nello strumento di IA che preferisce, che poi scrive la bozza della descrizione API.
- Tema
- App e prototipi
- Tipo
- Modello
- Livello
- Intermedio
- Tempo
- circa 15 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.
paths: /orders/{id}: get: summary: Recuperare un ordine responses: "200": { $ref: "#/components/schemas/Order" } "404": { description: Ordine non trovato } Punti aperti: - status: qui «open», in /orders «pending» - Formato di errore di /refunds sconosciuto
Compili
Ciò che scrive resta in questa finestra del browser. Non salviamo né inviamo nulla.
- backend di un negozio con ordini e prodotti
- servizio interno per gli account utente
- piccola API REST di un progetto personale
- API per partner e clienti
- endpoint di webhook
- definizioni delle rotte dal codice
- richieste e risposte di esempio
- una vecchia pagina wiki
- log di chiamate reali senza dati personali
- un mix di questi
- documentazione per i partner
- generare un client
- verifiche di contratto nella build
- inserimento di nuovi sviluppatori
- una prima panoramica
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.
- Incolli esempi con valori inventati; token reali e dati dei clienti non vanno nel materiale.
Perché funziona?
Una descrizione scritta a partire dal codice mostra le lacune che nessuno nota finché il codice funziona: errori non documentati, campi con due significati e rotte che escono dallo schema.
Consigli
- Confronti la bozza con l'API in funzione prima di pubblicarla; una descrizione diversa dalla realtà è peggio di nessuna.