RESTful API kaynak adlandırmadaki tekil isimler için argüman nedir?


12

RESTful URI'ları adlandırırken, kaynak koleksiyonlarını temsil etmek için çoğulların kullanılmasının yaygın olarak kabul edildiğini anlıyorum. Bunun yerine tekil isimler kullanma argümanını merak ediyorum.


belki her şey bir koleksiyon olmadığı için?
jwenting

Tek bir kaynağın devreye gireceği yer bu değil mi?
sadaka

Yanıtlar:


12

Bazı kaynaklar yalnızca tek bir öğe içerir. İyi örnekler, hangi verilerin oluşturulacağını bulmak için kimliğe ihtiyacınız olmayan her şey olabilir. Örneğin çok yaygın olan Giriş kaynağıdır. (Kullanıcılar ve tarayıcılar görünümünden) yalnızca tek bir girişiniz var. Onu oluşturabilir, yok edebilirsiniz, ancak aralarından seçim yapabileceğiniz birkaç Giriş ile bir dizin işleminiz olmayacaktır.

Benzer örnekler, şirket bilgileri, baskılar, iletişim formları ve yalnızca tek bir öğe görüntüleyen veya yalnızca tek bir oluşturma eylemine izin veren benzer şeyler gibi çoğunlukla statik sayfalar olabilir.

Tekil isimler kullanmanın, kodun okunabilirliğine gerçekten çok şey katması bir tartışma konusu olabilir.


5

Çünkü:

  1. "Kiraz" gibi İngilizce çoğul kurallar API geliştirirken düşünülecek en güzel şey değildir, özellikle İngilizce ana diliniz değilse.
  2. Bazen, genellikle tekil olan modelden son nokta oluşturmak istersiniz. Yukarıdakilerle iyi oynamaz.
  3. "Bir listeyi görüntülemeye git ile sorgulamaya başlıyorsunuz" argümanı gerçek bir kullanım durumuna işaret etmez. Ve tek bir öğeyi bir öğe listesi kadar ve hatta daha fazlasını sorgulayacaksınız.
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.