Dokumentasi REST API di GitBook
Budget: $250 – $750 USD
Saya sudah menyiapkan kerangka dasar di GitBook, namun masih berupa catatan mentah. Tugas Anda adalah merapikan, melengkapi, dan menyajikan dokumentasi REST API tersebut agar siap dibaca klien eksternal.
Fokusnya mencakup:
• Menjabarkan setiap endpoint beserta metode HTTP-nya
• Menambahkan contoh permintaan dan tanggapan yang mudah di-copy-paste
• Merinci daftar parameter dan penjelasan setiap fungsi
• Menyusun tabel kode kesalahan lengkap dengan deskripsi solusinya
Struktur GitBook-nya sudah tersedia dan kontennya juga sudah 50% tersedia; Anda tinggal melakukan review, melengkapi konten , mengisi, menautkan, dan memformat bab, sub-bab, serta halaman referensi hingga tampil rapi dan konsisten (TOC, breadcrumbs, search friendly).
Dokumentasi akhir harus:
1. Ter-preview sempurna di GitBook tanpa error format Markdown.
2. Mengandung flow nyata “request → response” yang bisa langsung diuji dengan cURL atau Postman.
3. Menggunakan gaya bahasa formal-ringan, jelas, dan bebas jargon internal.
Bila Anda terbiasa memakai Swagger/OpenAPI, Redoc, atau Postman Collection sebagai sumber, silakan manfaatkan; hasil akhirnya tetap harus di-render sepenuhnya di GitBook. Saya siap memberi akses payload, dan feedback harian.
Berikan tautan portofolio GitBook serupa yang pernah Anda kerjakan, dan perkiraan waktu penyelesaian untuk melihat apakah cocok dengan timeline kami.
Fokusnya mencakup:
• Menjabarkan setiap endpoint beserta metode HTTP-nya
• Menambahkan contoh permintaan dan tanggapan yang mudah di-copy-paste
• Merinci daftar parameter dan penjelasan setiap fungsi
• Menyusun tabel kode kesalahan lengkap dengan deskripsi solusinya
Struktur GitBook-nya sudah tersedia dan kontennya juga sudah 50% tersedia; Anda tinggal melakukan review, melengkapi konten , mengisi, menautkan, dan memformat bab, sub-bab, serta halaman referensi hingga tampil rapi dan konsisten (TOC, breadcrumbs, search friendly).
Dokumentasi akhir harus:
1. Ter-preview sempurna di GitBook tanpa error format Markdown.
2. Mengandung flow nyata “request → response” yang bisa langsung diuji dengan cURL atau Postman.
3. Menggunakan gaya bahasa formal-ringan, jelas, dan bebas jargon internal.
Bila Anda terbiasa memakai Swagger/OpenAPI, Redoc, atau Postman Collection sebagai sumber, silakan manfaatkan; hasil akhirnya tetap harus di-render sepenuhnya di GitBook. Saya siap memberi akses payload, dan feedback harian.
Berikan tautan portofolio GitBook serupa yang pernah Anda kerjakan, dan perkiraan waktu penyelesaian untuk melihat apakah cocok dengan timeline kami.
Related categories:
PHP
Copywriting
Data Entry
Health & Medicine
Indonesian Translator
cURL
Documentation
API Development
API Testing
REST API