Descrizione del progetto
TradottoLa nostra API REST è cresciuta a più di quaranta endpoint e, a questo punto, nessuno di essi è documentato. Gli sviluppatori che si integrano con noi stanno effettivamente facendo reverse engineering dell'API a partire da richieste di esempio, il che rallenta tutti e genera un flusso costante di domande di supporto evitabili. Vogliamo risolvere questo problema in modo adeguato commissionando una specifica completa OpenAPI 3.0 insieme a un portale per sviluppatori ben curato che le persone possano effettivamente leggere e provare.
Stiamo cercando qualcuno che combini una forte scrittura tecnica con una reale esperienza pratica nell'API, perché questo lavoro riguarda tanto la chiara spiegazione quanto gli schemi accurati. Produrrà una specifica OpenAPI 3.0 YAML completa che copre ogni endpoint, i suoi schemi di richiesta e risposta e i suoi codici di errore, quindi trasformerà tutto ciò in documenti interattivi ospitati con Swagger UI o Redoc. Oltre al riferimento, abbiamo bisogno di una guida per iniziare che spieghi l'autenticazione, i limiti di frequenza, la paginazione e la gestione degli errori, oltre a esempi di codice da copiare e incollare in cURL, PHP e JavaScript per ogni endpoint principale. Completa il tutto con un'esportazione della collezione Postman e un modello di changelog per la cronologia delle versioni.
Forniremo accesso all'API, la nostra documentazione interna esistente e l'elenco completo degli endpoint; ci aspettiamo la documentazione finita entro ventuno giorni.
Consegne:
— 1. Specifica OpenAPI 3.0 YAML — tutti gli endpoint, schemi di richiesta/risposta, codici di errore
— 2. Documenti API interattivi — pagina ospitata Swagger UI o Redoc
— 3. Guida per iniziare — autenticazione, limiti di frequenza, paginazione, errori
— 4. Esempi di codice — cURL, PHP, JavaScript per ogni endpoint principale
— 5. Changelog — modello di cronologia delle versioni
— 6. Esportazione della collezione Postman
Processo:
— Forniamo: accesso all'API, documenti del codice esistente, elenco degli endpoint
— Tu consegni: documenti completi in 21 giorni
— Richiesta di forte scrittura tecnica più esperienza API necessaria
Stiamo cercando qualcuno che combini una forte scrittura tecnica con una reale esperienza pratica nell'API, perché questo lavoro riguarda tanto la chiara spiegazione quanto gli schemi accurati. Produrrà una specifica OpenAPI 3.0 YAML completa che copre ogni endpoint, i suoi schemi di richiesta e risposta e i suoi codici di errore, quindi trasformerà tutto ciò in documenti interattivi ospitati con Swagger UI o Redoc. Oltre al riferimento, abbiamo bisogno di una guida per iniziare che spieghi l'autenticazione, i limiti di frequenza, la paginazione e la gestione degli errori, oltre a esempi di codice da copiare e incollare in cURL, PHP e JavaScript per ogni endpoint principale. Completa il tutto con un'esportazione della collezione Postman e un modello di changelog per la cronologia delle versioni.
Forniremo accesso all'API, la nostra documentazione interna esistente e l'elenco completo degli endpoint; ci aspettiamo la documentazione finita entro ventuno giorni.
Consegne:
— 1. Specifica OpenAPI 3.0 YAML — tutti gli endpoint, schemi di richiesta/risposta, codici di errore
— 2. Documenti API interattivi — pagina ospitata Swagger UI o Redoc
— 3. Guida per iniziare — autenticazione, limiti di frequenza, paginazione, errori
— 4. Esempi di codice — cURL, PHP, JavaScript per ogni endpoint principale
— 5. Changelog — modello di cronologia delle versioni
— 6. Esportazione della collezione Postman
Processo:
— Forniamo: accesso all'API, documenti del codice esistente, elenco degli endpoint
— Tu consegni: documenti completi in 21 giorni
— Richiesta di forte scrittura tecnica più esperienza API necessaria
Testi e traduzione Contante, Bonifico bancario
