Sistem Tasarımı Hile Sayfası: API Stilleri - REST, GraphQL, WebSocket, Webhook, RPC/gRPC, SOAP

Bu, sistem mimarisi tasarımındaki belirli bir konunun ana noktalarını kısaca ele aldığım bir dizi makalenin devamı niteliğindedir. İlk makaleyi okuyabilirsiniz buradan API mimarisi, yazılım bileşenlerinin nasıl etkileşimde bulunması gerektiğini belirleyen kurallar, protokoller ve araçlar kümesini ifade eder. Bir API'nin mimarisi yalnızca iletişimi kolaylaştırmakla ilgili değildir; aynı zamanda bu iletişimin verimli, güvenli ve ölçeklenebilir olmasını sağlamakla da ilgilidir. İyi tasarlanmış bir API mimarisi sistemin performansını önemli ölçüde artırabilirken, kötü tasarlanmış bir API mimarisi darboğazlara, güvenlik açıklarına ve bakım kabuslarına yol açabilir. API Mimarisinin Farklı Stilleri En yaygın API tasarım stilleri: (Temsili Durum Transferi), standart yöntemleri ve HTTP protokollerini kullanan en çok kullanılan stildir. Durumsuzluk, istemci-sunucu mimarisi ve önbelleğe alınabilirlik gibi ilkelere dayanır. Genellikle ön uç istemciler ve arka uç hizmetler arasında kullanılır. REST API'ler için bir sorgulama dilidir. Her kaynak için sabit bir uç nokta kümesi ortaya koyan REST'ten farklı olarak GraphQL, müşterilerin tam olarak ihtiyaç duydukları verileri talep etmelerine olanak tanıyarak aşırı alımları azaltır. GraphQL, , TCP üzerinden iki yönlü iletişime izin veren bir protokoldür. Müşteriler, arka uç sistemlerden gerçek zamanlı güncellemeler almak için web yuvalarını kullanır. WebSocket bir sistemin belirli olaylar hakkında başka bir sistemi gerçek zamanlı olarak bilgilendirmesine olanak tanıyan bir mekanizmadır. Kullanıcı tanımlı bir HTTP geri çağrısıdır. Webhook, bir hizmetin ağdaki başka bir bilgisayarda bulunan bir hizmetten prosedür/yöntem istemek için kullanabileceği bir protokoldür. Genellikle düşük gecikmeli, yüksek hızlı iletişim için tasarlanmıştır. RPC (gRPC), web servislerini uygulamak için yapılandırılmış bilgi alışverişine yönelik bir protokoldür. XML'e dayanır ve şu anda eski bir protokol olarak kabul edilen sağlamlığı ve güvenlik özellikleriyle tanınır. SOAP, Her protokole tüm artıları, eksileri ve kullanım durumları ile ayrı ayrı bakalım. DİNLENMEK standart kuralları ve protokolleri kullanan, anlaşılmasını ve uygulanmasını kolaylaştıran bir mimari stildir. Durum bilgisi olmayan yapısı ve standart HTTP yöntemlerinin kullanılması, onu web tabanlı API'ler oluşturmak için popüler bir seçim haline getiriyor. REST, REST, uzun süredir API oluşturmak için fiili standart olsa da, verileri sorgulamak ve işlemek için farklı paradigmalar sunan GraphQL gibi başka stiller de ortaya çıktı. : XML, JSON, HTML, düz metin Biçim : HTTP/HTTPS Aktarım protokolü Temel Kavramlar ve Özellikler : REST'te her şey bir kaynaktır. Kaynak, bir türe, ilişkili verilere, diğer kaynaklarla ilişkilere ve üzerinde çalışan bir dizi yönteme sahip bir nesnedir. Kaynaklar URI'leriyle (genellikle bir URL) tanımlanır. Kaynak : REST hizmetleri genellikle kaynaklardaki CRUD (Oluşturma, Okuma, Güncelleme, Silme) işlemleriyle doğrudan eşleşir. CRUD İşlemleri : REST sistemleri standart HTTP yöntemlerini kullanır: HTTP Yöntemleri GET: Bir kaynağı alın. POST: Yeni bir kaynak oluşturun. PUT/PATCH: Mevcut bir kaynağı güncelleyin. DELETE: Bir kaynağı kaldırın. : REST API'leri, bir API isteğinin başarılı veya başarısız olduğunu belirtmek için standart HTTP durum kodlarını kullanır: Durum Kodları 2xx - Takdir ve Başarı 200 - Tamam 201 - Yaratıldı 202 - Kabul edildi 3xx - Yönlendirme 301 - Kalıcı Olarak Taşındı 302 - Bulundu 303 - Diğerlerini Gör 4xx - İstemci Hatası 400 - Hatalı İstek 401 - Yetkisiz 403 yasak 404 Bulunamadı 405 - Yönteme İzin Verilmiyor 5xx - Sunucu Hatası 500 - Dahili Sunucu Hatası 501 - Uygulanmadı 502 sunucu hatası 503 Hizmet Kullanılamıyor 504 Geçidi Zaman Aşımı : Bir istemciden sunucuya yapılan her istek, isteği anlamak ve işlemek için gereken tüm bilgileri içermelidir. Sunucu, istekler arasında istemcinin durumu hakkında hiçbir şey saklamamalıdır. Durum Bilgisi Olmayan : REST, istemci-sunucu modelini temel alır. İstemci kullanıcı arayüzü ve deneyiminden sorumludur; sunucu ise isteklerin işlenmesinden, iş mantığının yönetilmesinden ve verilerin depolanmasından sorumludur. İstemci-Sunucu : Sunucudan gelen yanıtlar istemci tarafından önbelleğe alınabilir. Sunucu, yanıtın önbelleğe alınıp alınamayacağını belirtmelidir. Önbelleğe Alınabilir : Bir istemci normalde doğrudan uç sunucuya mı yoksa bir aracıya mı bağlı olduğunu anlayamaz. Aracı sunucular, yük dengelemeyi etkinleştirerek ve paylaşılan önbellekler sağlayarak sistemin ölçeklenebilirliğini geliştirebilir. Katmanlı Sistem Uygulamanın Motoru Olarak Hypermedia Stat, istemcilerin bir web uygulamasıyla etkileşim kurmasına ve yanıtlarında tamamen sunucu tarafından dinamik olarak sağlanan hipermedyaya dayalı olarak gezinmesine olanak tanıyan, gevşek bağlantı ve keşfedilebilirliği teşvik eden bir REST web hizmeti ilkesidir. HATEOAS: Kullanım Durumları : Birçok web hizmeti, işlevlerini REST API'leri aracılığıyla kullanıma sunarak üçüncü taraf geliştiricilerin hizmetlerini entegre etmesine ve genişletmesine olanak tanır. Web Hizmetleri : Mobil uygulamalar genellikle veri almak ve göndermek için REST API'lerini kullanarak arka uç sunucularla iletişim kurar. Mobil Uygulamalar : SPA'lar, tam sayfa yenileme gerektirmeden içeriği dinamik olarak yüklemek için REST API'lerini kullanır. Tek Sayfa Uygulamaları (SPA'lar) Bir kuruluş içindeki sistemler, REST API'lerini kullanarak iletişim kurabilir ve veri paylaşabilir. Sistemler Arası Entegrasyon: Örnek Rica etmek “/kullanıcı/42”yi alın Cevap { "id": 42, "name": "Alex", "links": { "role": "/user/42/role" } } GrafikQL özellikle karmaşık sistemlerde veya ön ucun yüksek esnekliğe ihtiyaç duyduğu durumlarda API oluşturmaya yönelik daha esnek, sağlam ve etkili bir yaklaşım sunar. Sorumluluğun bir kısmını sunucudan istemciye kaydırarak istemcinin veri gereksinimlerini belirlemesine olanak tanır. GraphQL, Tüm senaryolarda REST'in yerini almasa da, özellikle uygulamaların daha fazla ağ bağlantılı ve dağıtık hale gelmesiyle birlikte birçok durumda ilgi çekici bir alternatif sunar. : JSON Biçim : HTTP/HTTPS Aktarım protokolü Temel Kavramlar ve Özellikler : Müşterilerin ihtiyaç duydukları verileri talep etmelerine olanak tanıyarak gerekli tüm bilgilerin tek bir istekte alınmasını mümkün kılar. API'ler için Sorgu Dili : GraphQL API'leri uç noktalara göre değil türlere ve alanlara göre düzenlenir. Bir API'nin yeteneklerini tanımlamak için güçlü bir tür sistemi kullanır. Bir API'de sunulan tüm türler, GraphQL Şema Tanımlama Dili (SDL) kullanılarak bir şemaya yazılır. Tür Sistemi : Farklı kaynaklar için birden fazla uç noktaya sahip olabileceğiniz REST'ten farklı olarak GraphQL'de genellikle hizmetin tüm yeteneklerini ifade eden tek bir uç noktayı ortaya çıkarırsınız. Tek Uç Nokta : Sunucu tarafında çözümleyiciler bir sorguda açıklanan verileri toplar. Çözümleyiciler : GraphQL, verileri sorgulamanın ötesinde, abonelikleri kullanan gerçek zamanlı güncellemeler için yerleşik destek içerir. Aboneliklerle Gerçek Zamanlı Güncellemeler : Bir GraphQL sunucusu desteklediği türler açısından sorgulanabilir. Bu, istemci ve sunucu arasında güçlü bir sözleşme oluşturarak araç kullanımına ve daha iyi doğrulamaya olanak tanır. İçe dönük Kullanım Durumları : Önemli bant genişliğine sahip uygulamalar (özellikle mobil) için, sunucudan alınan verileri en aza indirmek istiyorsunuz. Esnek Ön Uçlar : Birden fazla mikro hizmetiniz varsa, bu hizmetlerden gelen verileri birleşik bir API'de toplamak için bir GraphQL katmanı tanıtılabilir. Mikro Hizmetlerin Toplanması : GraphQL, abonelik sistemiyle sohbet uygulamaları, canlı spor güncellemeleri vb. gibi gerçek zamanlı verilere ihtiyaç duyan uygulamalar için mükemmel bir seçim olabilir. Gerçek Zamanlı Uygulamalar : REST ile, değişiklikler yapıldıktan sonra genellikle API'lerinizi sürümlendirmeniz gerekir. GraphQL ile istemciler yalnızca gerekli verileri talep eder, böylece yeni alanlar veya türler eklemek önemli değişiklikler yaratmaz. Sürümsüz API'ler Örnek Rica etmek GET “/graphql?query=user(id:42){ ad rolü { kimlik adı } }” Cevap { "data": { "user": { "id": 42, "name": "Alex", "role": { "id": 1, "name": "admin" } } } } WebSocket tek ve uzun ömürlü bir bağlantı üzerinden tam çift yönlü bir iletişim kanalı sağlayarak istemci ile sunucu arasında gerçek zamanlı veri alışverişine olanak tanır. Bu onu etkileşimli ve yüksek performanslı web uygulamaları için ideal kılar. WebSockets, : İkili Biçim : TCP Taşıma protokolü Temel Kavramlar ve Özellikler : Geleneksel istek-yanıt modelinden farklı olarak WebSockets, açık kalan tam çift yönlü bir iletişim kanalı sağlayarak gerçek zamanlı veri alışverişine olanak tanır. Kalıcı Bağlantı : WebSockets bir HTTP isteği olarak başlar ve daha sonra sunucunun desteklemesi durumunda bir WebSocket bağlantısına yükseltilir. Bu, 'Yükseltme' başlığı aracılığıyla yapılır. Yükseltme El Sıkışma : Bağlantı kurulduğunda veriler çerçeveler halinde iletilir. Bu çerçeveler aracılığıyla hem metin hem de ikili veriler gönderilebilir. Çerçeveler : WebSockets, her santral için yeni bir bağlantı açmanın ek yükü olmadan istemci ve sunucu arasında doğrudan iletişime olanak tanır. Bu daha hızlı veri alışverişi sağlar. Düşük Gecikme : Hem istemci hem de sunucu birbirlerine bağımsız olarak mesaj gönderebilir. Çift Yönlü : İlk bağlantıdan sonra, veri çerçevelerinin gönderilmesi için daha az bayt gerekir; bu, tekrar tekrar HTTP bağlantıları kurmaktan daha az ek yüke ve daha iyi performansa yol açar. Daha Az Ek Yük : WebSockets, alt protokolleri ve uzantıları destekleyerek temel WebSocket protokolünün üstünde standartlaştırılmış ve özel protokollere olanak tanır. Protokoller ve Uzantılar Kullanım Durumları : Oyuncuların eylemlerinin anında diğer oyunculara yansıtılması gereken gerçek zamanlı çok oyunculu oyunlar. Çevrimiçi Oyun : Birden fazla kullanıcının bir belgeyi aynı anda düzenleyebildiği ve birbirlerinin değişikliklerini gerçek zamanlı olarak görebildiği Google Dokümanlar gibi uygulamalar. Ortak Çalışma Araçları : Hisse senedi fiyatlarının gerçek zamanlı olarak güncellenmesi gereken hisse senedi alım satım platformları. Finansal Uygulamalar : Sosyal medya platformları veya mesajlaşma uygulamaları gibi kullanıcıların gerçek zamanlı bildirimler alması gereken herhangi bir uygulama. Bildirimler : Yeni gönderilerin veya güncellemelerin kullanıcılara canlı olarak yayınlandığı haber siteleri veya sosyal medya platformları. Canlı Yayınlar Örnek Rica etmek “ws://site:8181” alın Cevap HTTP/1.1 101 Anahtarlama Protokolleri Web kancası , belirli web uygulaması olayları tarafından tetiklenen, gerçek zamanlı veri güncellemelerine ve farklı sistemler arasında entegrasyonlara olanak tanıyan, kullanıcı tanımlı bir HTTP geri çağrısıdır. Webhook : XML, JSON, düz metin Biçim : HTTP/HTTPS Aktarım protokolü Temel Kavramlar ve Özellikler : Web kancaları genellikle bir olayın meydana geldiğini belirtmek için kullanılır. Düzenli aralıklarla veri istemek yerine, web kancaları verileri olduğu gibi sağlar ve geleneksel istek-yanıt modelini tersine çevirir. Olay Odaklı : Web kancaları esasen kullanıcı tanımlı bir geri arama mekanizmasıdır. Belirli bir olay meydana geldiğinde, kaynak site, hedef site tarafından sağlanan URI'ye bir HTTP geri çağrısı yapar ve daha sonra belirli bir eylem gerçekleştirir. Geri Arama Mekanizması : Webhook tetiklendiğinde kaynak site, hedef siteye veri (payload) gönderir. Bu veriler genellikle JSON veya XML biçimindedir. Payload : Web kancaları, uygulamaların gerçek zamanlı veriler almasına olanak tanıyarak onları oldukça duyarlı hale getirir. Gerçek zamanlı : Kullanıcılar veya geliştiriciler genellikle hangi belirli olaylar hakkında bilgilendirilmek istediklerini tanımlayabilirler. Özelleştirilebilir : Web kancaları, kullanıcı tanımlı HTTP uç noktalarına geri çağrı yapılmasını içerdiğinden, güvenlik sorunları oluşturabilir. Uç noktanın güvenli olduğundan, verilerin doğrulandığından ve muhtemelen şifrelendiğinden emin olmak çok önemlidir. Güvenlik Kullanım Durumları : Kod gönderildiğinde veya bir çekme isteği birleştirildiğinde derlemelerin ve dağıtımların tetiklenmesi. Sürekli Entegrasyon ve Dağıtım (CI/CD) : İçerik güncellendiğinde, yayınlandığında veya silindiğinde alt sistemlere bildirimde bulunulması. İçerik Yönetim Sistemleri (CMS) : Başarılı ödemeler, başarısız işlemler veya geri ödemeler gibi işlem sonuçları hakkında e-ticaret platformlarını bilgilendirmek. Ödeme Ağ Geçitleri : Sosyal medya platformlarındaki yeni gönderiler, bahsetmeler veya diğer ilgili etkinlikler hakkında bildirim alma. Sosyal Medya Entegrasyonları : Cihazlar veya sensörler, diğer sistemleri veya hizmetleri belirli olaylar veya veri okumaları hakkında bilgilendirmek için web kancalarını tetikleyebilir. IoT (Nesnelerin İnterneti) Örnek Rica etmek " " ALIN https://external-site/webhooks?url=http://site/service-h/api&name=name Cevap { "webhook_id": 12 } RPC ve gRPC (Uzaktan Yordam Çağrısı), bir programın başka bir adres alanında bir yordamı veya alt yordamı yürütmesine olanak tanıyan, dağıtılmış sistemler arasında kesintisiz iletişim ve veri alışverişini sağlayan bir protokoldür. RPC (Google RPC), aktarım için HTTP/2'yi ve arayüz açıklama dili olarak Protokol Arabelleklerini kullanan, verimli ve sağlam iletişimi kolaylaştırmak için kimlik doğrulama, yük dengeleme ve daha fazlası gibi özellikler sağlayan, RPC üzerine kurulmuş modern, açık kaynaklı bir çerçevedir. mikro hizmetler arasında. gRPC RPC : JSON, XML, Protobuf, Thrift, FlatBuffers Format : Çeşitli Taşıma protokolü Temel Kavramlar ve Özellikler : RPC, bir programın başka bir adres alanında (genellikle paylaşılan bir ağdaki başka bir bilgisayarda) bir yordamın (alt yordam) yürütülmesine neden olmasına olanak tanır. Bu, arayanınkinden farklı bir makinede gerçekleştirilen bir işlevi çağırmak gibidir. Tanım : RPC bağlamında taslaklar, yerel ve uzak prosedür çağrılarının aynı görünmesini sağlayan araçlar tarafından oluşturulan kod parçalarıdır. İstemcinin uzak prosedüre benzeyen bir saplaması vardır ve sunucunun argümanları açan, gerçek prosedürü çağıran ve ardından sonuçları geri gönderilmek üzere paketleyen bir saplaması vardır. Taslaklar : Geleneksel RPC çağrıları engelleniyor; bu, istemcinin sunucuya bir istek göndermesi ve sunucudan yanıt beklerken engellenmesi anlamına gelir. Varsayılan olarak eşzamanlı : Birçok RPC sistemi, farklı istemci ve sunucu uygulamalarının, yazıldıkları dilden bağımsız olarak iletişim kurmasına izin verir. Dil Tarafsız : RPC genellikle istemcinin ve sunucunun çağrılan prosedürü, parametrelerini ve dönüş türünü bilmesini gerektirir. Sıkı Bağlantı Kullanım Durumları : RPC, bir sistemin parçalarının farklı makinelere veya ağlara yayıldığı ancak yerelmiş gibi iletişim kurmasının gerektiği dağıtılmış sistemlerde yaygın olarak kullanılır. Dağıtılmış Sistemler : NFS (Ağ Dosya Sistemi), dosya işlemlerini uzaktan gerçekleştiren RPC'lerin bir örneğidir. Ağ Dosya Sistemleri Örnek Rica etmek { "method": "addUser", "params": [ "Alex" ] } Cevap { "id": 42, "name": "Alex", "error": null } gRPC : Protobuf Biçim : HTTP/2 Aktarım protokolü Temel Kavramlar ve Özellikler : gRPC, Google tarafından geliştirilen açık kaynaklı bir RPC çerçevesidir. Aktarım için HTTP/2'yi, arayüz açıklama dili olarak Protokol Tamponlarını (Protobuf) kullanır ve kimlik doğrulama, yük dengeleme özellikleri ve daha fazlasını sağlar. Tanım : Bu, yapılandırılmış verileri serileştirmek için dilden bağımsız, platformdan bağımsız, genişletilebilir bir mekanizmadır. GRPC ile Protobuf'u kullanarak hizmet yöntemlerini ve mesaj türlerini tanımlarsınız. Protokol Tamponları : gRPC, düşük gecikme süresi ve yüksek aktarım hızı iletişimi için tasarlanmıştır. HTTP/2, tek bir bağlantı üzerinden birden fazla çağrının çoğullanmasına olanak tanır ve ek yükü azaltır. Performans : gRPC, akış isteklerini ve yanıtlarını destekleyerek uzun ömürlü bağlantılar, gerçek zamanlı güncellemeler vb. gibi daha karmaşık kullanım durumlarına olanak tanır. Akış : gRPC, istemcilerin bir RPC'nin tamamlanması için ne kadar bekleyeceklerini belirtmelerine olanak tanır. Sunucu bunu kontrol edebilir ve işlemin tamamlanıp tamamlanmayacağına veya çok uzun sürecekse iptal edilip edilmeyeceğine karar verebilir. Son Tarihler/Zaman Aşımları : gRPC takılabilir kimlik doğrulamayı, yük dengelemeyi, yeniden denemeleri vb. destekleyecek şekilde tasarlanmıştır. Takılabilir : RPC gibi gRPC de dilden bağımsızdır. Ancak Protobuf ve gRPC araçlarıyla birden çok dilde istemci ve sunucu kodu oluşturmak kolaydır. Dil Tarafsız Kullanım Durumları : gRPC, performans özellikleri ve hizmet sözleşmelerini kolayca tanımlayabilmesi nedeniyle mikro hizmet mimarilerinde yaygın olarak kullanılır. Mikro hizmetler : Akış desteği göz önüne alındığında, gRPC, sunucuların istemcilere gerçek zamanlı olarak veri gönderdiği gerçek zamanlı uygulamalar için uygundur. Gerçek Zamanlı Uygulamalar : gRPC'nin performans avantajları ve akış yetenekleri, onu arka uç hizmetleriyle iletişim kuran mobil istemciler için iyi bir seçim haline getirir. Mobil İstemciler Örnek message User { int id = 1 string name = 2 } service UserService { rpc AddUser(User) returns (User); } SABUN Basit Nesne Erişim Protokolü anlamına gelen , bilgisayar ağlarında web servislerini uygulamak için yapılandırılmış bilgi alışverişini sağlayan bir protokoldür. Farklı işletim sistemlerinde çalışan programların birbirleriyle iletişim kurmasını sağlayan XML tabanlı bir protokoldür. SOAP : XML Biçim : HTTP/HTTPS, JMS, SMTP ve daha fazlası Aktarım protokolü Temel Kavramlar ve Özellikler : SOAP mesajları XML olarak biçimlendirilir ve aşağıdaki öğeleri içerir: XML Tabanlı : XML belgesini SOAP mesajı olarak tanımlayan SOAP mesajının kök öğesi. Zarf : Bir ara noktada veya nihai uç noktada, mesajın işlenmesinde kullanılan mesajın isteğe bağlı niteliklerini içerir. Başlık : Gönderilen mesajı içeren XML verilerini içerir. Gövde : Mesajı işlerken hatalar hakkında bilgi sağlayan isteğe bağlı bir Arıza öğesi. Arıza : SOAP herhangi bir programlama modeliyle kullanılabilir ve belirli bir programlama modeline bağlı değildir. Tarafsızlık : Her işletim sisteminde ve her dilde çalışabilir. Bağımsızlık : Bir istemciden sunucuya yapılan her istek, isteği anlamak ve işlemek için gereken tüm bilgileri içermelidir. Durum Bilgisi Olmayan : SOAP mesajındaki Fault öğesi, hata raporlama için kullanılır. Yerleşik Hata İşleme : SOAP spesifikasyonunun kendisi de dahil olmak üzere iyi tanımlanmış standartların yanı sıra mesaj teslimini sağlamak için WS-ReliableMessaging, mesaj güvenliği için WS-Security ve daha fazlası gibi ilgili standartlar temelinde çalışır. Standartlaştırılmış Kullanım Durumları : SOAP, sağlamlığı, genişletilebilirliği ve güvenlik duvarları ile proxy'leri geçebilme yeteneği nedeniyle kurumsal ortamlarda sıklıkla kullanılır. Kurumsal Uygulamalar : Birçok web hizmeti, özellikle eski olanlar, SOAP kullanır. Buna Microsoft ve IBM gibi büyük şirketlerin sunduğu hizmetler de dahildir. Web Hizmetleri : SOAP'ın yerleşik güvenliği ve genişletilebilirliği, onu veri bütünlüğü ve güvenliğin çok önemli olduğu finansal işlemler için iyi bir seçim haline getirir. Finansal İşlemler : Telekomünikasyon şirketleri, farklı sistemlerin güvenilir bir şekilde iletişim kurması gereken faturalama gibi işlemler için SOAP'ı kullanabilir. Telekomünikasyon Örnek Rica etmek Alex Cevap 42 Alex Çözüm API mimarisi stilleri çok çeşitlidir; REST, SOAP, RPC ve daha fazlası gibi her biri benzersiz güçlü yönlere ve kullanım senaryolarına sahip çeşitli yaklaşımlar sunar ve geliştiricilerin farklı yazılımlar arasında ölçeklenebilir, verimli ve sağlam entegrasyonlar oluşturmak için en uygun paradigmayı seçmesine olanak tanır. bileşenler ve sistemler.