Untuk memasukkan ID sumber daya dalam muatan atau berasal dari URI

Mendesain API, kami menemukan pertanyaan apakah muatan PUT harus berisi ID sumber daya yang diperbarui.

Inilah yang saat ini kami miliki:

PUT /users/123 Payload: {name: "Adrian"}

Kode rute kami mengekstraksi ID dari URI dan melanjutkan pembaruan.

Pengguna pertama API kami mempertanyakan mengapa kami tidak mengizinkan ID dalam muatan:

PUT /users/123 Payload: {id: 123, name: "Adrian"}

Alasan kami tidak mengizinkannya adalah karena ID digandakan, dalam payload dan URI.

Memikirkan hal ini lagi, kami menggabungkan sumber daya ke URI.

Jika URI tidak memiliki ID, payload perlu diubah:

PUT /no/id/here Payload: {name: "Adrian"} < What user???

Apakah ada alasan untuk tidak melakukannya?

Anda seharusnya memasangkan Uniform Resource Identifier ke sumber daya .

Ketika REST diimplementasikan dengan HTTP, Anda menggunakan GET untuk mengambil nilai sumber daya saat ini dan PUT untuk menetapkan nilai baru. GET tidak memiliki muatan, sehingga sumber daya harus diidentifikasi oleh URI. Dan PUT secara logis dilakukan untuk URI yang sama dan muatannya akan terlihat persis seperti apa yang Anda inginkan GET berikutnya.

Anda dapat menggunakan POST untuk URI yang berbeda, tetapi itu hanya akan kurang masuk akal karena tidak perlu asimetris dengan GET. POST ke URI umum hanya masuk akal untuk menciptakan sumber daya baru ( POST /users/new, payload:, {name: "Adrian"}respon {id: 345, name: "Adrian"}), tetapi itu tidak idempoten dan karena itu harus dihindari jika Anda berjuang untuk REST¹. Alih-alih, Anda harus memesan ID dengan satu panggilan dan kemudian menggunakan PUT untuk mengatur ID baru; itu toleran terhadap kesalahan, karena jika permintaan pertama gagal, reservasi ID akhirnya bisa habis dan PUTidempoten. Atau gunakan UUID yang dihasilkan klien.

¹ Definisi REST tidak mengatakan apa-apa tentang idempoten, jadi saya tidak bisa benar-benar mengklaim itu bukan REST jika Anda memiliki operasi non-idempoten. Itu tidak mengubah fakta bahwa berpegang pada permintaan idempoten membuat hal-hal lebih dapat diandalkan tanpa menyulitkan mereka dan karenanya direkomendasikan.

Memikirkan hal ini lagi, kami menggabungkan sumber daya ke URI.

Jika URI tidak memiliki ID, payload perlu diubah:

PUT / no / id / di sini Payload: {name: "Adrian"} <Pengguna apa ???

Apakah ada alasan untuk tidak melakukannya?

Jawaban untuk pertanyaan ini tergantung pada apakah Anda ingin mengizinkan klien untuk mengubah ID?

Jika klien dapat mengubah ID, melalui PUT, maka URI untuk sumber daya akan berubah, dan Anda harus memberikan 301 Pindah Secara Permanen kapan saja sumber daya mengakses URI yang lama.

Jadi misalnya Anda mulai dengan sumber daya di

/users/123

dan klien PUT berikut ini ke sumber daya

{id: 222, name: "Adrian"}

sumber daya telah diperbarui dan URI-nya sekarang

/users/222

The Locationlapangan di respon PUT harus berisi URI baru, dan jika Anda pergi ke /users/123Anda harus mendapatkan 301respon dengan Lokasi lapangan menunjuk ke baru /users/222sumber daya.

Dalam kebanyakan kasus, Anda sebenarnya tidak ingin klien dapat mengubah ID, karena ini bisa menjadi sangat berantakan dengan cepat. Dalam hal ini ID adalah sesuatu yang hanya dapat diubah oleh server, dan Anda harus meninggalkannya dari tubuh PUT, karena klien tidak dapat memperbarui keadaan ini.

Jika Anda PUT suatu kebutuhan untuk URI berbeda pada sumber daya yang sama, katakanlah

/users/adian_lync

maka jika sumber daya itu tidak ada server harus membuat dan membuat dan ID ketika sedang melakukannya