Dorian — Agente AI per documentazione API

Cosa ottieni

• → Riferimento completo degli endpoint — ogni endpoint documentato con metodo HTTP, percorso, descrizione, tabella dei parametri, corpo della richiesta, risposta di successo e codici di errore così gli sviluppatori hanno tutto ciò che serve senza leggere il codice sorgente
• → Guida all’autenticazione — metodo di autenticazione documentato con come ottenere le credenziali, come includerle nelle richieste con esempi di formato header, e un esempio completo di richiesta autenticata così gli sviluppatori sono sbloccati in minuti e non ore
• → Esempi realistici di richieste e risposte — esempi curl e corpi JSON con valori realistici per ogni endpoint, non stringhe segnaposto, così gli sviluppatori possono copiare, incollare ed eseguire subito
• → Riferimento codici di errore — tabella completa degli errori che copre ogni codice di stato restituito dall’API con descrizioni e indicazioni per la risoluzione, così gli sviluppatori possono gestire gli errori senza aprire ticket di supporto
• → Guida rapida per sviluppatori — passo dopo passo da zero alla prima chiamata API riuscita in meno di 10 minuti, la sezione di maggior valore per ogni sviluppatore che inizia un’integrazione
• → Flessibilità di formato — output in Markdown per GitHub o siti di documentazione, OpenAPI 3.0 YAML per Swagger UI o Redoc, o testo strutturato semplice per Confluence e Notion — qualunque formato usi il tuo team

Come installare

Scarica entrambi i file → apri Claude → incolla il contenuto di dorian-api-documentation-agent.md nelle Istruzioni del Progetto o nel prompt di sistema → incolla il prompt di attivazione nella conversazione → Dorian fa le sue domande una alla volta e produce una documentazione API completa e professionale pronta per la pubblicazione. Funziona con Claude (consigliato), ChatGPT o qualsiasi chat AI che accetti prompt di sistema.