Apa kode status HTTP yang tepat untuk dikembalikan oleh layanan REST API untuk kegagalan validasi?

Saat ini saya mengembalikan 401 Tidak Sah setiap kali saya mengalami kegagalan validasi dalam aplikasi REST API berbasis Django / Piston saya . Setelah melihat Registry Status Status HTTP, saya tidak yakin bahwa ini adalah kode yang sesuai untuk kegagalan validasi, apa yang Anda rekomendasikan?

• 400 permintaan Buruk
• 401 Tidak Resmi
• 403 Dilarang
• 405 Metode Tidak Diizinkan
• 406 Tidak Dapat Diterima
• 412 Prasyarat Gagal
• 417 Harapan Gagal
• 422 Entitas yang Tidak Dapat Diproses
• 424 Dependensi Gagal

Pembaruan : "Kegagalan validasi" di atas berarti kegagalan validasi data tingkat aplikasi, mis., Waktu data yang ditentukan salah, alamat email palsu dll.

Jika "kegagalan validasi" berarti ada beberapa kesalahan klien dalam permintaan, maka gunakan HTTP 400 (Permintaan Buruk). Misalnya jika URI seharusnya memiliki tanggal ISO-8601 dan Anda menemukan bahwa itu dalam format yang salah atau mengacu pada 31 Februari, maka Anda akan mengembalikan HTTP 400. Ditto jika Anda mengharapkan XML yang terbentuk dengan baik dalam badan entitas dan gagal mem-parsing.

(1/2016): Selama lima tahun terakhir, HTTP 422 (Unprocessable Entity) WebDAV yang lebih spesifik telah menjadi alternatif yang sangat masuk akal untuk HTTP 400. Lihat misalnya penggunaannya dalam JSON API . Tetapi harap dicatat bahwa HTTP 422 belum membuatnya menjadi HTTP 1.1, RFC-7231 .

Richardson dan Ruby RESTful Web Services berisi lampiran yang sangat membantu tentang kapan harus menggunakan berbagai kode respons HTTP. Mereka bilang:

400 ("Permintaan Buruk")
Pentingnya: Tinggi.
Ini adalah status kesalahan sisi klien umum, digunakan ketika tidak ada kode kesalahan 4xx lain yang sesuai. Ini biasanya digunakan ketika klien mengirimkan representasi bersama dengan permintaan PUT atau POST, dan representasi tersebut dalam format yang benar, tetapi itu tidak masuk akal. (hal. 381)

dan:

401 ("Tidak Sah")
Pentingnya: Tinggi.
Klien mencoba untuk beroperasi pada sumber daya yang dilindungi tanpa memberikan kredensial otentikasi yang tepat. Mungkin memberikan kredensial yang salah, atau tidak sama sekali. Kredensial dapat berupa nama pengguna dan kata sandi, kunci API, atau token autentikasi — apa pun layanan yang diharapkan. Sudah umum bagi klien untuk membuat permintaan untuk URI dan menerima 401 hanya supaya tahu kredensial macam apa yang akan dikirim dan dalam format apa. [...]

Dari RFC 4918 (dan juga didokumentasikan di http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml ):

Kode status 422 (Entitas yang Tidak Dapat Diproses) berarti server memahami jenis konten entitas permintaan (oleh karena itu kode status 415 (Jenis Media yang Tidak Didukung) tidak pantas), dan sintaks entitas permintaan benar (dengan demikian 400 (Permintaan Buruk) ) kode status tidak pantas) tetapi tidak dapat memproses instruksi yang terkandung. Sebagai contoh, kondisi kesalahan ini dapat terjadi jika badan permintaan XML berisi formulasi XML yang baik (yaitu, benar secara sintaksis), tetapi secara semestinya salah.

Duplikat dalam database harus a 409 CONFLICT.

Saya sarankan menggunakan 422 UNPROCESSABLE ENTITYuntuk kesalahan validasi.

Saya memberikan penjelasan lebih lama tentang kode 4xx di sini: http://parker0phil.com/2014/10/16/REST_http_4xx_status_codes_syntax_and_sematics/

Ini dia:

rfc2616 # section-10.4.1 - 400 Permintaan Buruk

Permintaan tidak dapat dipahami oleh server karena sintaksis yang salah . Klien TIDAK HARUS mengulangi permintaan tanpa modifikasi.

rfc7231 # section-6.5.1 - 6.5.1. 400 permintaan Buruk

Kode status 400 (Permintaan Buruk) menunjukkan bahwa server tidak dapat atau tidak akan memproses permintaan karena sesuatu yang dianggap sebagai kesalahan klien (misalnya, sintaks permintaan salah bentuk, pembingkaian pesan permintaan tidak valid, atau perutean permintaan yang menipu) .

Mengacu pada kasus yang cacat (tidak berbentuk baik)!

rfc4918 - 11.2. 422 Entitas yang Tidak Dapat Diproses

Kode status 422 (Entitas yang Tidak Dapat Diproses) berarti server
memahami jenis konten entitas permintaan (oleh karena itu kode status 415 (Jenis Media yang Tidak Didukung) tidak pantas), dan sintaks entitas permintaan benar (dengan demikian 400 (Permintaan Buruk) ) kode status tidak pantas) tetapi tidak dapat memproses instruksi yang terkandung. Misalnya, kondisi kesalahan ini dapat terjadi jika badan permintaan XML berisi formulasi XML yang baik (yaitu, benar secara sintaksis), tetapi secara semestinya salah .

Kesimpulan

Rule of thumb: [_] 00 mencakup kasus dan kasus yang paling umum yang tidak dicakup oleh kode yang ditentukan.

422 cocok dengan kesalahan validasi objek terbaik (tepatnya rekomendasi saya :)
Adapun kesalahan semantik - Pikirkan sesuatu seperti "Nama pengguna ini sudah ada" validasi.

400 salah digunakan untuk validasi objek

Saya akan mengatakan secara teknis itu mungkin bukan kegagalan HTTP, karena sumber daya itu (mungkin) ditentukan secara sah, pengguna diautentikasi, dan tidak ada kegagalan operasional (namun bahkan spek itu menyertakan beberapa kode cadangan seperti 402 Dibutuhkan Pembayaran yang diperlukan ' t secara tegas terkait dengan HTTP, meskipun mungkin disarankan untuk menggunakannya pada tingkat protokol sehingga perangkat apa pun dapat mengenali kondisinya).

Jika memang demikian, saya akan menambahkan bidang status ke respons dengan kesalahan aplikasi, seperti

<status><code>4</code> <message> Rentang tanggal tidak valid </message> </status>

Ada sedikit lebih banyak informasi tentang semantik kesalahan ini di RFC 2616 , yang mendokumentasikan HTTP 1.1.

Secara pribadi, saya mungkin akan menggunakan 400 Bad Request, tetapi ini hanya pendapat pribadi saya tanpa dukungan faktual.

Apa sebenarnya yang Anda maksud dengan "kegagalan validasi"? Apa yang Anda validasi? Apakah Anda merujuk pada sesuatu seperti kesalahan sintaksis (mis. XML cacat)?

Jika itu masalahnya, saya akan mengatakan 400 Permintaan Buruk mungkin adalah hal yang benar, tetapi tanpa mengetahui apa yang Anda "validasikan", tidak mungkin untuk mengatakannya.