SORU
22 NİSAN 2009, ÇARŞAMBA


REST API için herhangi bir adlandırma kuralı kurallar vardır?

REST API oluştururken, API içinde adlandırma kurallarına göre, herhangi bir kılavuz veya Amerikan standartlarına (örn: yol bileşenleri, sorgu dizesi parametreleri) URL bitiş noktası vardır? Deve caps norm, ya da alt çizgi vardır? Diğerleri?

Örneğin:

api.service.com/helloWorld/userId/x

ya

api.service.com/hello_world/user_id/x

Not: Bu Dinlendirici bir API tasarımı bir soru değil, daha ziyade adlandırma kuralları nihai yolu bileşenleri ve/veya sorgu dizesi parametreleri kullanıldığı için kullanılacak.

Herhangi bir kurallar mutluluk duyacağız.

CEVAP
22 NİSAN 2009, ÇARŞAMBA


Yakından sıradan web kaynakları için URI bak. Bu şablon vardır. Dizin ağaçları düşün; kullanımı basit Linux-dosya ve dizin adları.

HelloWorld kaynakların çok iyi bir sınıf değil. Bir olmak görünmüyor"". şey Olabilir, ama isim gibi değil. greeting bir şey.

user-id çekici bir isim olabilir. Senin isteğin sonucu bir user_id sadece şüpheli, ancak,. İsteği sonucu bir Kullanıcı olduğundan çok daha büyük bir ihtimal. Bu nedenle, user isim olduğunu sen çok çekicisin

www.example.com/greeting/user/x/

Bana mantıklı geliyor. DİNLENMEYE isim ifade hiyerarşi (ya da taksonomi veya dizin) üzerinden bir yol -- Bir tür istekte odaklanın. Basit isimler mümkün, mümkünse isim cümleleri kaçınarak kullanın.

Genellikle, bileşik isim cümleleri genellikle hiyerarşi içinde başka bir adım. /hello-world/user/ /hello-universe/user/ zorunda kalmazsınız. /hello/world/user/ hello/universe/user/. Ya da muhtemelen /world/hello/user/ /universe/hello/user/.

Nokta kaynakları arasında bir gezinti yolu bulunur.

Bunu Paylaş:
  • Google+
  • E-Posta
Etiketler:

YORUMLAR

SPONSOR VİDEO

Rastgele Yazarlar

  • Ash100HD

    Ash100HD

    29 EKİM 2011
  • EmbarkToHeaven

    EmbarkToHeav

    3 EYLÜL 2007
  • fast2hell

    fast2hell

    16 AĞUSTOS 2006