NodeJS ve API Tasarım Temelleri

1. NodeJS ve RESTful API
Tasarım Temelleri

2. Hüseyin BABAL
Full Stack Developer
PHP, JAVA, NodeJS geliştiricisi.
Ölçeklenebilir ve gerçek zamanlı uygulama tasarımcısı.
Web Geliştirme Danışmanı.
Girişimci.
NodeJS eğitmeni.
GDG konferans konuşmacısı
@huseyinbabal @huseyinbabal http://huseyinbaba
l.net

3. Resource
URI
Representat
ions
HTTP Verbs Resources

4. Resource
Verisi olan bir
nBeirs UneRI ile
bHeTliTrtPilm oipşerasyonları
uygulanabilir

5. Collection(articles) Singleton(article)
/articles /articles/{articleI
d}

6. Sub-collections
/articles/{articleId}/comments
/articles/{articleId}/comments/{commentId} (Sub-collection
resource)

7. Http Verbs
Article Create
Article Update
Article Delete

8. URI HTTP
METHOD
DESCRIPTION
/articles GET Makaleleri listele
/articles POST Yeni makale oluştur
/articles/:id GET Makale detayını göster
/articles/:id DELETE Makaleyi sil
/articles/:id PUT Makaleyi komple güncelle
/articles/:id PATCH Makalenin belirli bir kısmını

9. Representation
XML
JSON
Statistics

10. Resource URI
Unique Resource Identifier

11. Resource Seçimi
Uygulama alanını analiz et
İhityaçlarını tespit et
Kullanıcının anlayacağı şekilde seçim yap
Resource adı çoğul olsun

13. Bazen Resource adı Bulunamıyor
Mesela makaleyi aktif etmek için ne yapılabilir?
POST
/articles/:id/activate

14. ...ya da

15. ...
Ek örnek olarak “Arama” için tam olarak bir
Resource yoktur.
/search
Çok iyi dökümente etmek lazım

16. SSL

17. Dökümantasyon
Detaylı bilgi
Örnek
rTeeqsut eesdt/ilreebsiplior nCsuerl
sorguları

18. Fine Grained Resource (Tane tane)
Önce makale detayını gönder
Sonra makale etiket ve kategorileri gir
En son olarak da email gönder

19. Kullanıc bunu nerden bilecek?

20. Coarse Grained Resource (Toplu)
Tek seferde bütün makale detaylarını gönder

21. İş Mantığının Kullanıcı Tarafında
olması
İlk önce makale içeriğini gir
Sonra kategori bilgisini gönder

22. Kullanıcı kategori bilgisini göndermezse
ne olacak?

23. Bir aksiyonun birde fazla Resource
etkilemesi
Aksiyon-X = ∱(Resource-A, Resource-B,
Resource-C)
=
Aksiyon-X, Resource-X şeklinde gösterilebilir

24. Örnek
Para Transfer Olayı => Para, Müşteri Hesabı
Para Transfer Olayı, Para Transfer Log
Resource olarak gösterilebilir

25. Ekstra Operasyonlar
CRUD operasyonların haricinde;
- sıralama
- sayfalama
- filtreleme
- arama
gibi işlemler için url parametresi kullanablirsiniz

26. Sıralama
/articles?sort=-created_at,rank

27. Filtreleme
/articles?activated=true

28. Arama
/articles?q=NodeJS

29. Sayfalama
/articles?page=2&limit=25

30. Birlikte Kullanımı
/articles?q=NodeJS&sort=-created_at&limit=20

31. Response Nasıl Olmalı?
PUT, POST, PATCH için 201 dönüp, dönen
makalenin urlsini Location Header içine
koyabilirsiniz

32. Resource Alan Adları
snake_case alan adları camelCase alan
adlarından %20 daha iyi okunaklı.
http://www.cs.kent.edu/~jmaletic/papers/ICPC2010-CamelCaseUnderScoreClouds.pdf

33. Response prettyprint olsun ama gerektiğinde
gzip yapılabilsin

34. KB
Pretty 3.2X
Ugly 3X
Pretty & Gzip 1.25X
Ugly & Gzip 1X

35. Response Formatı
{
result: “Makale oluşturuldu”
}

36. Başarılı Sonuç

37. Hatalı Sonuç

38. Belirli formata sahip sonuç formatı yerine
dinamik ve genişleyebilen json formatı
kullanmak daha iyidir
Ama JSONP servisi veriyorsanız envelop tarzı
olabilir

39. Versiyonlama
URL içinde versiyon
kullanmayın
http://article.com/api/v3.0/articles/123 (Bad)

40. … Onun yerine
Versiyon bilgisini header içinde
yollayın
GET /articles/123
Accept:
application/vnd.huseyinbabal.blogging.article-v3+
json

41. Daha da kötüsü
http://yourdomain.com/api/v3.0/articles/v2.5/co
mments/v1.7/likes

42. Versiyonlama Mimarisi
Sunucu bazlı versiyon
Aynı sunucuda farklı versiyon

43. Sunucu Bazlı Versiyon
v1
v2
v1
v1
Accept-
Version:v1
Accept-
Version:v2

44. Aynı Sunucu Farklı Versiyon
v1,
v2 v1,
v2
v1,
v2
v1,
Accept-
Version:v1
Accept-
Version:v2

45. Farklı yaklaşım

46. Yeni versiyon çıkınca blog ya da emailing
yoluyla haberdar et

47. Rate Limiting
X-Rate-Limit-Limit => Toplam sorgu limiti (t
periyodundan)
X-Rate-Limit-Remaining => Kalan Toplam sorgu limiti (t
periyodundan)
X-Rate-Limit-Reset => Kaç saniye sonra bloklanacak (t
periyodundan)

48. ETag ve Last-Modified
ETag => MD5(response)
Last-Modified => En son güncelleme

49. Kimlik Doğrulama
Session, Cookie yok
Header içinde token yollanılmalı

50. NodeJS Örnek RESTful API
https://github.com/huseyinbabal/nodes-restful-api