Panduan Penggunaan Kode Status REST API

Menyajikan kriteria praktis untuk memilih kode status yang tepat bagi setiap situasi di REST API.

REST API yang dirancang baik menyampaikan hasil permintaan dengan jelas melalui kode status. Gunakan 200 OK untuk pembacaan yang berhasil, 201 Created untuk pembuatan sumber daya (dengan URL baru di header Location), dan 204 No Content untuk keberhasilan tanpa body yang dikembalikan (misalnya penghapusan).

Kesalahan klien dibedakan dengan 4xx. Standarnya adalah 400 Bad Request untuk sintaksis yang salah, 401 Unauthorized ketika autentikasi diperlukan, 403 Forbidden untuk tidak adanya izin, 404 Not Found untuk sumber daya yang tidak ada, 409 Conflict untuk konflik status, 422 Unprocessable Content untuk kegagalan validasi, dan 429 Too Many Requests untuk permintaan yang berlebihan.

Kesalahan server ditandai dengan 5xx. Gunakan 500 Internal Server Error untuk pengecualian tak terduga dan 503 Service Unavailable untuk kelebihan beban atau pemeliharaan, dan sertakan header Retry-After bila memungkinkan. Yang terpenting, selalu mengembalikan kode yang sama secara konsisten untuk situasi yang sama adalah hal yang menentukan kegunaan sebuah API.