Apa argumen untuk kata benda tunggal dalam penamaan sumber daya API RESTful?


12

Saya mengerti bahwa ketika menamai RESTful URI, biasanya diterima menggunakan bentuk jamak untuk mewakili koleksi sumber daya. Saya ingin tahu argumen untuk menggunakan kata benda tunggal sebagai gantinya.


mungkin karena tidak semuanya koleksi?
jwenting

Bukankah di situlah sumber daya tunggal akan berperan?
charness

Jawaban:


12

Beberapa sumber daya hanya mengandung satu item. Contoh yang baik akan menjadi segalanya yang Anda tidak memerlukan ID untuk mencari tahu data apa yang akan disajikan. Sangat umum misalnya akan menjadi sumber masuk. Anda hanya memiliki (dari tampilan pengguna dan browser) satu login. Anda dapat membuatnya, Anda dapat menghancurkannya tetapi Anda tidak akan memiliki tindakan indeks dengan beberapa Login untuk dipilih.

Contoh serupa akan berupa sebagian besar halaman statis seperti informasi perusahaan, cetakan, formulir kontak, dan hal-hal serupa yang hanya menampilkan satu item atau hanya memungkinkan tindakan tunggal.

Ini bisa menjadi masalah diskusi jika menggunakan kata benda tunggal benar-benar menambah banyak keterbacaan kode.


5

Karena:

  1. Aturan jamak bahasa Inggris seperti "ceri" bukan hal terbaik untuk dipikirkan saat mengembangkan API, terutama ketika bahasa Inggris bukan bahasa ibu Anda.
  2. Terkadang Anda ingin menghasilkan titik akhir dari model, yang biasanya tunggal. Itu tidak cocok dengan yang di atas.
  3. Argumen "biasanya Anda mulai meminta dengan menampilkan daftar" untuk tidak menampilkan kasus penggunaan nyata. Dan Anda akhirnya akan menanyakan satu item sebanyak dan bahkan lebih dari daftar item.
Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.