Esempio di app / Stockroom API
Un backend su cui un'altra applicazione può fare affidamento
Il risultato ha un contratto documentato e una gestione prevedibile degli errori. Un elenco di endpoint senza validazione, test o configurazione dell'ambiente di esecuzione non è un'API completa.
Mantieni persistenti i record dei prodotti e dei movimenti scegliendo come aggiungere un database gestito all'API.
/products
Elenca e filtra i prodotti.
/movements
Valida e registra le variazioni delle scorte.
/inventory
Restituisci le scorte attuali calcolate.
/health
Segnala l'integrità del processo senza dati privati.
Prima di scrivere il prompt
Scrivi il contratto prima di generare i gestori delle richieste
Inizia dagli utilizzatori e dalle risorse. Così l'IA ha un motivo per ogni route, campo, codice di stato e permesso, invece di generare un'interfaccia CRUD generica.
Utilizzatore definito
Indica l'app web, l'app mobile, lo strumento interno o il partner che chiamerà l'API.
Proprietà delle risorse
Indica se i record sono pubblici o appartengono a un utente, a un team o a un servizio.
Contratto per la gestione degli errori
Scegli una struttura sicura degli errori JSON e codici di risposta significativi prima dell'implementazione.
Prove per l'ambiente di esecuzione
Tieni insieme i requisiti per avvio, porta, controlli di integrità, database, segreti, migrazione e test di funzionamento essenziali.
Se devi confrontare gli stack prima di scrivere il prompt, consulta le Guide alla distribuzione di API.
Progetta il contratto
Chiedi route, dati, permessi e test prima del codice
Questo prompt fa esaminare all'agente lo stack esistente e mostrare prima il contratto dell'API. Sostituisci i valori tra parentesi quadre e rivedi la risposta come specifica operativa dell'API.
Aiutami a pianificare un'API REST strutturata per la produzione in questo spazio di lavoro Adios. Non modificare ancora i file.
L'API:
- Nome: [NOME DELL'API]
- Utilizzatore: [APP WEB, APP MOBILE, STRUMENTO INTERNO O PARTNER]
- Risorsa principale: [RISORSA]
- Azioni principali: [CREAZIONE, ELENCO, LETTURA, AGGIORNAMENTO O ALTRE AZIONI]
- Autenticazione: [NESSUNA PER UNA DEMO PUBBLICA, TOKEN UTENTE O CHIAVE API DEL SERVIZIO]
- Database: [DATABASE ATTUALE DEL PROGETTO O POSTGRES]
Prima di proporre modifiche, esamina il repository, il framework attuale, il gestore di pacchetti, i test, la route del controllo di integrità, la configurazione dell'ambiente e adios.yaml.
Forniscimi:
1. la tabella delle route con metodi e codici di risposta;
2. le strutture di richieste e risposte;
3. la validazione e la gestione degli errori;
4. il modello di dati e l'approccio alle migrazioni;
5. i confini di autenticazione e autorizzazione;
6. le considerazioni sui limiti di richieste e sugli abusi;
7. i test automatizzati e gli esempi manuali con curl;
8. la configurazione necessaria in Adios per l'ambiente di esecuzione, i controlli di integrità, il database e i segreti.
Preferisci lo stack esistente. Spiega ogni nuova dipendenza. Attendi la mia approvazione prima di modificare i file.Cosa contiene una risposta utile
- Una tabella delle route al posto di una lista di funzionalità desiderate
- Strutture di richieste, risposte, validazione ed errori
- Un modello esplicito di proprietà e autorizzazione
- Requisiti dell'ambiente di esecuzione e dei test prima delle modifiche
Implementa il contratto
Crea l'API senza sostituire lo stack funzionante
Dopo aver approvato il contratto, usa questo prompt per implementarlo con errori coerenti, accesso parametrizzato ai dati, test ed esempi eseguibili.
Crea l'API REST dal piano che ho approvato.
Requisiti:
- Mantieni linguaggio, framework, gestore di pacchetti e file di distribuzione Adios esistenti.
- Conserva un endpoint leggero di integrità senza autenticazione che non esponga dati privati.
- Valida ogni input esterno e restituisci errori JSON con una struttura coerente.
- Applica autenticazione e autorizzazione sul server quando il piano le richiede.
- Usa accesso parametrizzato al database tramite il livello dati già adottato dal progetto.
- Aggiungi migrazioni reversibili se il repository usa migrazioni.
- Non inserire mai credenziali direttamente nel codice. Referenzia i valori del database e dell'autenticazione tramite i nomi delle variabili di ambiente.
- Aggiungi documentazione API concisa e richieste di esempio eseguibili.
- Aggiungi test per il caso ideale, input non validi, record mancanti, accesso non autorizzato e un caso di errore del database testabile in sicurezza.
- Esegui il formattatore, il linter, i test e il comando di build o compilazione di produzione già usati dal progetto.
Al termine, fornisci tabella delle route, file modificati, risultati dei test, configurazione Adios necessaria e comandi esatti da eseguire su Preview. Non distribuire in produzione.Cosa contiene una risposta utile
- Gestori delle richieste conformi alla tabella delle route approvata
- Validazione e gestione degli errori coerenti
- Test per casi riusciti, errori e controllo degli accessi
- Richieste per Preview da copiare
Metti alla prova le ipotesi
Prova input malformati, limiti di accesso e richieste ripetute
Una richiesta riuscita nel caso ideale dimostra poco. Questo prompt di revisione verifica il contratto dal punto di vista di un client sconosciuto o inaffidabile.
Rivedi questa API come se dovesse essere chiamata da un client sconosciuto. Correggi solo i problemi verificati e non distribuire.
Controlla che:
- le route usino i metodi HTTP e i codici di stato previsti;
- gli input malformati, mancanti, troppo grandi o inattesi vengano rifiutati in modo sicuro;
- l'autenticazione non possa essere aggirata e un chiamante non possa accedere ai dati protetti di un altro;
- le risposte di errore non espongano tracce dello stack, segreti, dettagli del database o percorsi interni;
- le richieste ripetute vengano gestite in modo sicuro dove è richiesta l'idempotenza;
- le scritture nel database e le migrazioni siano coerenti;
- la documentazione dell'API e le richieste di esempio corrispondano all'implementazione;
- i controlli di integrità restino leggeri;
- i log siano utili senza registrare credenziali o contenuti sensibili delle richieste;
- tutti i controlli di formattazione, lint, test, compilazione o build vadano a buon fine.
Forniscimi una tabella dei controlli e delle prove, le esatte richieste da eseguire in Preview e gli eventuali rischi residui.Cosa contiene una risposta utile
- Test sui casi non validi, oltre alle risposte 200
- Nessun dettaglio interno negli errori pubblici
- Documentazione verificata rispetto all'implementazione
- Un elenco esplicito dei rischi residui
Allinea il codice sorgente all'ambiente di esecuzione
Confronta il contratto API con il contratto di rilascio Adios
Il prompt finale verifica che codice sorgente, migrazione, comando di avvio, porta, percorso del controllo di integrità, dipendenze, segreti e test di funzionamento essenziali descrivano lo stesso rilascio.
Prepara questa API per una revisione della distribuzione su Adios. Non distribuire finché non l'ho approvata.
Verifica il comando di avvio, l'host e la porta di ascolto, il percorso del controllo di integrità, i nomi delle variabili d'ambiente richieste, la dipendenza dal database, il comando di migrazione e la route pubblica prevista. Confrontali con adios.yaml e segnala ogni incongruenza.
Poi forniscimi:
1. i risultati finali dei controlli automatizzati;
2. cinque richieste sicure per test di funzionamento essenziali sull'URL di Preview;
3. una nota sul ripristino della versione precedente o sul recupero dopo una migrazione non riuscita;
4. i segreti che devo configurare tramite Adios anziché nel codice sorgente;
5. un controllo dopo la distribuzione che includa integrità, log, autenticazione e un ciclo di scrittura e lettura.
Fermati e attendi la mia approvazione prima della distribuzione in produzione.Cosa contiene una risposta utile
- Nessuna incongruenza tra il processo e adios.yaml
- Test essenziali sicuri in Preview e in produzione
- Una nota sul ripristino dopo la migrazione
- Una pausa esplicita prima della distribuzione
Testa il risultato
Una compilazione riuscita è l'inizio della revisione
Apri Preview ed esegui personalmente i percorsi utente importanti. Chiedi evidenze all'agente, ma non confondere il suo riepilogo con la tua approvazione.
Contratto
- Ogni route, metodo, codice di stato e campo documentato corrisponde all'implementazione.
- Gli input malformati e inattesi restituiscono errori JSON sicuri con la stessa struttura.
- Paginazione, filtri e ordinamento si comportano in modo prevedibile, dove presenti.
Confine di fiducia
- Le credenziali mancanti, non valide, scadute o appartenenti a un altro proprietario vengono rifiutate in modo sicuro.
- Un errore pubblico non contiene stack trace, segreti, dettagli SQL o percorsi interni.
- I log omettono le credenziali e i contenuti sensibili delle richieste che non è necessario registrare.
Ambiente di esecuzione
- Il processo ascolta sull'host e sulla porta dichiarati.
- Migrazioni, controlli di integrità, formattazione, lint, test e verifiche di build o compilazione vanno a buon fine.
- Un test essenziale di scrittura e lettura va a buon fine in Preview e dopo il rilascio.
Punto di approvazione umana
Rilascia insieme il contratto dell'API e le relative prove
Tratta tabella delle route, migrazioni, nomi delle variabili d'ambiente, percorso del controllo di integrità, log e richieste di test essenziali come parte del rilascio. Approva solo quando corrispondono alla versione in esecuzione in Preview.
ospitare e distribuire l'API completa creata con l'IA- 01Esegui le richieste sicure in Preview e confrontale con la documentazione.
- 02Verifica le istruzioni di migrazione e ripristino del database per questa versione.
- 03Configura in Adios i segreti con i nomi previsti e mantieni i loro valori fuori dal codice sorgente.
- 04Verifica le impostazioni di avvio, porta, integrità e dipendenze in adios.yaml.
- 05Approva il rilascio, poi ripeti il controllo di integrità, l'autenticazione e un ciclo di scrittura e lettura.
Domande prima di iniziare
Cosa promette questa guida e quali sono i suoi limiti
Questa guida serve a creare un'API di IA o a creare la mia API con l'IA?
Usa l'agente IA di Adios per creare il backend della tua applicazione. L'API di esempio gestisce i dati di magazzino; non chiama un modello linguistico né espone l'API di un modello di IA.
Quale framework per il backend dovrei usare?
Preferisci il framework già usato dal repository. Se parti da zero, scegli uno stack che il tuo team sappia mantenere e che abbia convenzioni chiare per validazione, test, migrazioni e ambiente di esecuzione. Il prompt chiede all'agente di spiegare ogni nuova dipendenza.
L'endpoint di controllo dell'integrità di un'API deve richiedere l'autenticazione?
Un endpoint di integrità del processo è solitamente leggero e senza autenticazione, così la piattaforma può controllarlo, ma non deve esporre segreti, record privati, credenziali delle dipendenze o dettagli diagnostici interni.
Come faccio a sapere se un'API generata dall'IA può essere distribuita in sicurezza?
Non affidarti solo alla generazione. Rivedi il contratto, esegui test sui casi validi e non validi, verifica autorizzazioni ed errori, controlla la gestione dei segreti, applica le migrazioni in sicurezza, prova Preview e approva personalmente l'esatta versione candidata al rilascio.