Sfoglia categorie
Esplora
Fiverr Pro
Italiano
$
USD
Scriverò documentazione API, specifiche openapi swagger, guide per sviluppatori e documenti SDK
Documentazione tecnica e automazione dei dati per team di sviluppo software
Sono un ingegnere del software. Scrivo i documenti di cui i team di sviluppo hanno bisogno e che nessuno vuole scrivere: specifiche dei requisiti, riferimenti API, manuali utente, runbook. E automatiz...
Informazioni su questo servizio
Scrivimi pure in italiano.
La maggior parte della documentazione API è scritta da qualcuno che non sa leggere il codice. Per questo diventa obsoleta in tre settimane, e perché i tuoi utenti aprono ancora ticket chiedendo cosa significano i codici di errore.
Sono un ingegnere del software. Mandami il repository, la collezione Postman o il file delle route — lo leggo io stesso e scrivo documentazione che corrisponde a quello che il servizio fa realmente.
COSA OTTIENI
- Ogni endpoint: metodo, percorso, autenticazione, parametri, richiesta e risposta
- Risposte di errore reali, con le cause e cosa fare a riguardo
- Un esempio funzionante per ogni endpoint, in curl e in un linguaggio a tua scelta
- Un file OpenAPI 3 valido, così puoi rigenerare la documentazione dopo aver modificato il codice
- Un sito di documentazione pubblicato su Redoc, Swagger UI o Mintlify (Premium)
REST, GraphQL, webhooks e SDK. Non ho mai bisogno delle tue chiavi di produzione.
Se la tua API presenta problemi di naming o di gestione degli errori, te lo dirò prima di scrivere. Documentare un'API confusa rende solo ufficiale la confusione.
Tipo di documento:
Documentazione
•
Specifiche tecniche
Settore:
Software
Lingua:
Inglese
•
Italiana
Preferenza per lo stile di consegna
Informa il freelance di eventuali preferenze o preoccupazioni relative all'uso di strumenti di IA nel completamento e/o nella consegna dell'ordine.
Il mio portfolio
FAQ
Traduzione automatica.
Di cosa hai bisogno per documentare la mia API?
Qualsiasi di questi va bene: un repository, una collezione Postman, uno schema GraphQL, un file OpenAPI esistente o una chiave sandbox. Se non ne hai nessuno, una condivisione dello schermo in cui mi fai vedere le chiamate è sufficiente per iniziare.
Pubblicate la documentazione o me la consegnate solo come file?
Entrambe le opzioni sono possibili. La documentazione di base e di riferimento viene consegnata come Markdown più un file OpenAPI che puoi ospitare tu stesso. Full Docs include un sito di documentazione funzionante, costruito con un generatore statico, pronto per essere distribuito sul tuo dominio.
Mantieni aggiornata la documentazione quando l'API cambia?
Sì, come un ordine più piccolo e separato. Mandami il changelog o il diff e aggiorno le sezioni interessate. Poiché conservi i file sorgente, anche il tuo team può mantenerli senza il mio aiuto.
