Kenapa API Perlu Konsisten

Pengguna API adalah programmer lain. Konsistensi membuat mereka tidak perlu menebak.

Bab ini membahas tiga hal: penamaan URL jamak dan kata benda, kode status 200, 201, 204, 404, 422, dan format error yang sama di semua endpoint. Bacalah berurutan, karena bagian akhir memakai hasil dari bagian awal.

Gambaran

Sebelum menulis kode, pahami dulu masalah yang ingin diselesaikan. Pada topik Kenapa API Perlu Konsisten, kesalahan yang paling sering terjadi adalah langsung mencontoh potongan kode tanpa memahami kenapa kode itu ditulis begitu. Akibatnya, saat kebutuhan sedikit berbeda, kode tersebut sulit diubah.

Kita mulai dari penamaan URL jamak dan kata benda. Bagian ini menjadi dasar untuk dua bagian berikutnya.

Contoh

Berikut contoh yang akan kita kembangkan sepanjang bab:

public function store(Request $request): RedirectResponse
{
    $data = $request->validate([
        'name' => ['required', 'string', 'max:120'],
        'price' => ['required', 'integer', 'min:0'],
    ]);

    Product::create($data);

    return back()->with('toast', 'Produk tersimpan.');
}

Perhatikan bahwa setiap baris punya satu tugas. Pola ini memudahkan pengujian dan perubahan di kemudian hari.

Langkah

1. Mulai dari penamaan URL jamak dan kata benda, lalu pastikan hasilnya sesuai harapan.
2. Lanjutkan ke kode status 200, 201, 204, 404, 422. Di sinilah biasanya muncul pertanyaan, jadi bacalah pelan-pelan.
3. Terakhir, format error yang sama di semua endpoint. Bandingkan hasilnya dengan contoh di atas.

Ringkasan

• penamaan URL jamak dan kata benda
• kode status 200, 201, 204, 404, 422
• format error yang sama di semua endpoint

Di bab berikutnya kita memakai hasil bab ini sebagai dasar. Tandai bab ini selesai bila contoh di atas sudah berjalan di komputer Anda.