Alternatif RESTful untuk HAPUS Badan Permintaan

Meskipun spesifikasi HTTP 1.1 tampaknya mengizinkan badan pesan pada permintaan DELETE , tampaknya menunjukkan bahwa server harus mengabaikannya karena tidak ada semantik yang ditentukan untuk itu.

4.3 Isi Pesan

Server HARUS membaca dan meneruskan badan pesan berdasarkan permintaan apa pun; jika metode permintaan tidak menyertakan semantik yang ditentukan untuk badan entitas, maka badan pesan HARUS diabaikan saat menangani permintaan.

Saya telah meninjau beberapa diskusi terkait tentang topik ini di SO dan seterusnya, seperti:

• Apakah badan entitas diperbolehkan untuk permintaan HTTP DELETE?
• Muatan Metode Permintaan HTTP
• HTTP GET dengan isi permintaan

Sebagian besar diskusi tampaknya setuju bahwa memberikan badan pesan pada HAPUS mungkin diperbolehkan , tetapi umumnya tidak disarankan.

Lebih lanjut, saya telah memperhatikan tren di berbagai pustaka klien HTTP di mana semakin banyak peningkatan tampaknya dicatat untuk pustaka ini untuk mendukung badan permintaan di DELETE. Sebagian besar perpustakaan tampaknya menurut, meskipun kadang-kadang dengan sedikit penolakan awal.

Kasus penggunaan saya meminta penambahan beberapa metadata yang diperlukan pada DELETE (misalnya "alasan" untuk penghapusan, bersama dengan beberapa metadata lain yang diperlukan untuk penghapusan). Saya telah mempertimbangkan opsi berikut, tidak ada yang tampak sepenuhnya sesuai dan sejalan dengan spesifikasi HTTP dan / atau praktik terbaik REST:

• Isi Pesan - Spesifikasi menunjukkan bahwa badan pesan di DELETE tidak memiliki nilai semantik; tidak sepenuhnya didukung oleh klien HTTP; bukan praktik standar
• Header HTTP Kustom - Mewajibkan header khusus umumnya bertentangan dengan praktik standar ; menggunakannya tidak konsisten dengan API saya lainnya, tidak ada yang memerlukan tajuk khusus; selanjutnya, tidak ada respons HTTP yang baik yang tersedia untuk menunjukkan nilai header khusus yang buruk (mungkin pertanyaan yang sama sekali berbeda)
• Header HTTP Standar - Tidak ada header standar yang sesuai
• Parameter Kueri - Menambahkan parameter kueri sebenarnya mengubah URI Permintaan yang sedang dihapus; bertentangan dengan praktik standar
• Metode POST - (mis. POST /resourceToDelete { deletemetadata }) POST bukanlah opsi semantik untuk dihapus; POST sebenarnya mewakili tindakan berlawanan yang diinginkan (yaitu POST membuat bawahan sumber daya; tetapi saya perlu menghapus sumber daya)
• Beberapa Metode - Memisahkan permintaan DELETE menjadi dua operasi (misalnya PUT menghapus metadata, lalu DELETE) membagi operasi atom menjadi dua, berpotensi meninggalkan status yang tidak konsisten. Alasan penghapusan (dan metadata terkait lainnya) bukan bagian dari representasi resource itu sendiri.

Preferensi pertama saya mungkin menggunakan badan pesan, kedua setelah header HTTP kustom; namun, seperti yang ditunjukkan, ada beberapa kelemahan dari pendekatan ini.

Apakah ada rekomendasi atau praktik terbaik yang sejalan dengan standar REST / HTTP untuk menyertakan metadata yang diperlukan tersebut pada permintaan DELETE? Apakah ada alternatif lain yang belum saya pertimbangkan?

Terlepas dari beberapa rekomendasi untuk tidak menggunakan badan pesan untuk permintaan DELETE, pendekatan ini mungkin sesuai dalam kasus penggunaan tertentu. Ini adalah pendekatan yang akhirnya kami gunakan setelah mengevaluasi opsi lain yang disebutkan dalam pertanyaan / jawaban, dan setelah berkolaborasi dengan konsumen layanan.

Meskipun penggunaan badan pesan tidak ideal, tidak ada opsi lain yang juga cocok. Badan permintaan DELETE memungkinkan kami dengan mudah dan jelas menambahkan semantik di sekitar data / metadata tambahan yang diperlukan untuk menyertai operasi DELETE.

Saya masih terbuka untuk pemikiran dan diskusi lain, tetapi ingin menutup lingkaran tentang pertanyaan ini. Saya menghargai pemikiran dan diskusi semua orang tentang topik ini!

Apa yang tampaknya Anda inginkan adalah salah satu dari dua hal, tidak ada yang murni DELETE:

1. Anda memiliki dua operasi, salah PUTsatu alasan penghapusan diikuti oleh DELETEsumber daya. Setelah dihapus, konten sumber daya tidak dapat lagi diakses oleh siapa pun. 'Alasan' tidak boleh berisi hyperlink ke sumber daya yang dihapus. Atau,
2. Anda mencoba mengubah sumber daya dari state=activemenjadi state=deleteddengan menggunakan DELETEmetode ini. Sumber daya dengan status = dihapus diabaikan oleh API utama Anda tetapi mungkin masih dapat dibaca oleh admin atau seseorang dengan akses database. Ini diizinkan - DELETEtidak harus menghapus data pendukung untuk sumber daya, hanya untuk menghapus sumber daya yang diekspos di URI tersebut.

Operasi apa pun yang memerlukan badan pesan pada DELETEpermintaan dapat dipecah menjadi paling umum, POSTuntuk melakukan semua tugas yang diperlukan dengan badan pesan, dan a DELETE. Saya tidak melihat alasan untuk merusak semantik HTTP.

Mengingat situasi yang Anda alami, saya akan mengambil salah satu pendekatan berikut:

• Kirim PUT atau PATCH : Saya menyimpulkan bahwa operasi penghapusan bersifat virtual, yang pada dasarnya memerlukan alasan penghapusan. Oleh karena itu, saya yakin memperbarui rekaman melalui operasi PUT / PATCH adalah pendekatan yang valid, meskipun ini bukan operasi DELETE per se.
• Gunakan parameter kueri : Sumber daya uri tidak sedang diubah. Saya sebenarnya berpikir ini juga pendekatan yang valid. Pertanyaan yang Anda tautkan berbicara tentang tidak mengizinkan penghapusan jika parameter kueri tidak ada. Dalam kasus Anda, saya hanya akan memiliki alasan default jika alasannya tidak ditentukan dalam string kueri. Sumber daya akan tetap ada resource/:id. Anda dapat membuatnya dapat ditemukan dengan tajuk Tautan pada sumber daya untuk setiap alasan (dengan reltag pada setiap alasan untuk mengidentifikasi alasan).
• Gunakan titik akhir terpisah untuk setiap alasan : Menggunakan url seperti resource/:id/canceled. Ini benar-benar mengubah Request-URI dan jelas bukan RESTful. Sekali lagi, tajuk tautan dapat membuatnya dapat ditemukan.

Ingatlah bahwa REST bukanlah hukum atau dogma. Anggap saja lebih sebagai panduan. Jadi, jika masuk akal untuk tidak mengikuti panduan untuk domain masalah Anda, jangan. Pastikan saja konsumen API Anda diberi tahu tentang variansnya.

Saya sarankan Anda memasukkan metadata yang diperlukan sebagai bagian dari hierarki URI itu sendiri. Contoh (Naif):

Jika Anda perlu menghapus entri berdasarkan rentang tanggal, alih-alih meneruskan tanggal mulai dan tanggal akhir dalam isi atau sebagai parameter kueri, susun URI sedemikian rupa sehingga Anda meneruskan informasi yang diperlukan sebagai bagian dari URI.

misalnya

DELETE /entries/range/01012012/31122012 - Hapus semua entri antara 1 Januari 2012 hingga 31 Desember 2012

Semoga ini membantu.