Descrizione del progetto
TradottoLa nostra API REST è cresciuta fino a oltre quaranta endpoint, e nessuno di essi è documentato oggi. Gli sviluppatori che si integrano con noi essenzialmente ingegnerizzano a ritroso la logica dell'API dagli esempi di richiesta — questo rallenta le cose e crea un'inondazione di domande di supporto. Vogliamo risolvere questo problema in modo approfondito e commissionare una specifica completa OpenAPI 3.0 insieme a un portale sviluppatori rifinito dove la documentazione può essere sia letta che testata dal vivo.
Abbiamo bisogno di un esecutore che combini una forte scrittura tecnica con una reale esperienza API, perché il compito riguarda sia una chiara spiegazione che schemi precisi. Dobbiamo preparare una specifica YAML OpenAPI 3.0 completa per tutti gli endpoint — con schemi di richiesta e risposta e codici di errore — e poi trasformarla in documentazione interattiva in Swagger UI o Redoc. Oltre al riferimento, abbiamo bisogno di una guida per iniziare che copra autenticazione, limiti, paginazione e gestione degli errori, oltre a esempi di codice pronti in cURL, PHP e JavaScript per ciascun endpoint chiave. Una collezione Postman e un modello di changelog completano il quadro.
Forniamo accesso API, documentazione del codice interno e un elenco completo di endpoint; ci aspettiamo documentazione finita entro 21 giorni.
Risultato:
— 1. Specifica YAML OpenAPI 3.0 — tutti gli endpoint, schemi di richiesta/risposta, codici di errore
— 2. Documentazione interattiva (Swagger UI o Redoc)
— 3. Guida per iniziare — autenticazione, limiti, paginazione, errori
— 4. Esempi di codice — cURL, PHP, JS per ciascun endpoint chiave
— 5. Modello di changelog
— 6. Collezione Postman
Processo:
— Forniamo: accesso API, documentazione del codice, elenco di endpoint
— Tu: documentazione completa in 21 giorni
Abbiamo bisogno di un esecutore che combini una forte scrittura tecnica con una reale esperienza API, perché il compito riguarda sia una chiara spiegazione che schemi precisi. Dobbiamo preparare una specifica YAML OpenAPI 3.0 completa per tutti gli endpoint — con schemi di richiesta e risposta e codici di errore — e poi trasformarla in documentazione interattiva in Swagger UI o Redoc. Oltre al riferimento, abbiamo bisogno di una guida per iniziare che copra autenticazione, limiti, paginazione e gestione degli errori, oltre a esempi di codice pronti in cURL, PHP e JavaScript per ciascun endpoint chiave. Una collezione Postman e un modello di changelog completano il quadro.
Forniamo accesso API, documentazione del codice interno e un elenco completo di endpoint; ci aspettiamo documentazione finita entro 21 giorni.
Risultato:
— 1. Specifica YAML OpenAPI 3.0 — tutti gli endpoint, schemi di richiesta/risposta, codici di errore
— 2. Documentazione interattiva (Swagger UI o Redoc)
— 3. Guida per iniziare — autenticazione, limiti, paginazione, errori
— 4. Esempi di codice — cURL, PHP, JS per ciascun endpoint chiave
— 5. Modello di changelog
— 6. Collezione Postman
Processo:
— Forniamo: accesso API, documentazione del codice, elenco di endpoint
— Tu: documentazione completa in 21 giorni
Testi e traduzione Contante, Bonifico bancario
