Bayangkan kamu membeli sebuah perangkat elektronik canggih, tetapi di dalam kotaknya tidak ada buku panduan sama sekali. Tentu kamu akan bingung bagaimana cara menggunakannya.

Dokumentasi API adalah buku panduan untuk API kita.

Dokumentasi yang baik sangatlah penting karena:

• Memudahkan Kolaborasi: Tim frontend developer tidak perlu bertanya kepadamu setiap saat tentang endpoint apa yang harus digunakan, apa saja data yang harus dikirim, dan bagaimana format responsnya. Mereka cukup membaca dokumentasi.
• Menjadi Sumber Kebenaran Tunggal: Dokumentasi adalah acuan resmi tentang bagaimana API seharusnya bekerja. Ini mengurangi miskomunikasi.
• Mempercepat Proses Adaptasi: Anggota tim baru bisa mempelajari cara kerja API dengan cepat hanya dengan membaca dokumentasi.

Bagian 2: Menambahkan Deskripsi di Postman

Postman bukan hanya alat pengujian, ia juga bisa menjadi alat dokumentasi yang hebat. Caranya adalah dengan menambahkan deskripsi pada setiap request yang kita buat.

1. Pilih Sebuah Request: Di koleksi Postman-mu, klik pada salah satu request, misalnya GET /students.

2. Buka Panel Dokumentasi: Di sisi kanan jendela Postman, ada beberapa ikon. Klik ikon yang terlihat seperti halaman dokumen (📄 Documentation).

3. Tulis Deskripsi: Kamu akan melihat sebuah area teks di mana kamu bisa menulis deskripsi untuk request tersebut menggunakan format Markdown. Tuliskan penjelasan yang jelas.

   ### Mengambil Semua Data Siswa
   
   Endpoint ini digunakan untuk mengambil seluruh daftar siswa yang terdaftar di dalam database.
   
   **Respons Sukses (200 OK):**
   ```json
   [
       {
           "id": 1,
           "created_at": "2025-06-15T12:00:00.000Z",
           "nama": "Andi Pratama"
       },
       {
           "id": 3,
           "created_at": "2025-06-15T12:01:00.000Z",
           "nama": "Budi"
       }
   ]

4. Simpan Perubahan: Setelah selesai menulis, jangan lupa klik Save.

5. Ulangi untuk Request Lain: Lakukan hal yang sama untuk request lainnya (POST, PUT, DELETE), jelaskan fungsi, data apa yang dibutuhkan di body, dan contoh responsnya.

Bagian 3: Praktik: Membuat dan Mempublikasikan Dokumentasi

Setelah semua request memiliki deskripsi, saatnya mempublikasikan dokumentasi kita agar bisa diakses oleh siapa pun melalui sebuah tautan web.

1. Lihat Dokumentasi Koleksi: Klik pada titik tiga (...) di sebelah nama koleksimu, lalu pilih View documentation.
2. Pratinjau Dokumentasi: Kamu akan melihat pratinjau dari dokumentasi yang dihasilkan oleh Postman. Semua deskripsi yang sudah kamu tulis akan muncul di sini.
3. Publikasikan: Di pojok kanan atas halaman pratinjau, klik tombol Publish.
4. Atur Opsi Publikasi: Kamu bisa mengatur beberapa hal seperti warna dan gaya. Untuk sekarang, kita bisa menggunakan pengaturan default.
5. Klik “Publish” Lagi: Klik tombol Publish berwarna biru untuk mengonfirmasi.
6. Dapatkan Tautan Publik: Postman akan memberikanmu sebuah URL publik (contoh: https://documenter.getpostman.com/view/...).

Coba Buka Tautan Tersebut!

Buka URL tersebut di browser-mu. Kamu akan melihat sebuah halaman web dokumentasi yang terlihat sangat profesional, lengkap dengan contoh kode dalam berbagai bahasa pemrograman. Ini adalah “buku panduan” dari API-mu yang siap dibagikan ke seluruh dunia.