Dotnet üzerinden API Gateway ve Mikro Servis Mimarisine uygun proje yapımı
Merhaba, bu yazımda iki tane mikroservis yazacağız ve bunları da Api Gateway ile yöneteceğiz.
Api Gateway Nedir?
Api gateway, backend servisleriniz ile client arasında yer alan bir api yönetim aracıdır.
Api Gateway Ne Yapar?
Api gateway Client’dan gelen api çağrılarını alır ve uygun mikroservislere yönlendirir.
Örnek bir proje yapımı
Visual studio ortamında iki tane microservis yazıp bunları da api gateway ile yönlendirmelerini yapacağız.
Blank solution olarak projemizi açıp içine services klasörü ile bir ApiGateway .net 5.0 api projesi ekliyoruz.
Services klasörüne BookService ve UserService olmak üzere iki tane proje ekliyoruz bu servisler birbirinden tamamen bağımsız şekilde olacak biri kitaplar hakkında bize bilgiler verecek diğer servis de kullanıcılar hakkında kayıtlar döndürecek.
Bu servisler kendi içinde Domain Driven Design mimarisine uygun şekilde olacak.
Projemizin mimarisi artık hazır diyebiliriz. Kitap bilgilerini döndürecek BookService‘ine BookController ekleyelim bu controller altına da Get Actionu ekleyelim parametre olarak da isbn alsın Book\Get?isbn=”” ile bize kitabın bilgisi dönecek projemizin ana odağından kaçmama adına database eklemeden statik olarak bu verileri döndüreceğiz.
Book.Domain ve Book.Infasctructure katmanlarına services adında bir klasör oluşturalım domain tarafındaki oluşturduğumuz klasöre IBookService interface’i Infastructure katmanına da BookService class’ını ekleleyelim.
DTOS klasör altındaki BookDTO Modelimiz:
1 2 3 4 5 6 7 8 9 10 11 |
namespace Book.Domain.Models { public class BookDTO { public string ISBN { get; set; } public string Title { get; set; } public string Author { get; set; } public int PageCount { get; set; } public string PublisherName { get; set; } } } |
IBookService
1 2 3 4 5 6 7 8 9 |
using Book.Domain.Models; namespace Book.Domain.Services { public interface IBookService { BookDTO GetBookByISBN(string isbn); } } |
BookService :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
using Book.Domain.Models; using Book.Domain.Services; namespace Book.Infastructure.Services { public class BookService : IBookService { public BookDTO GetBookByISBN(string isbn) { if (string.IsNullOrEmpty(isbn)) { return null; } var book = new BookDTO { Author = "J.R.R Tolkien", ISBN = isbn, PageCount = 1012, PublisherName = "Metis Yayınevi", Title = "Yüzüklerin Efendisi Tek Cilt Özel Basım" }; return book; } } } |
Servisimizi yazdık şimdi middleware’da (startup.cs) bunları bağlayalım
1 |
services.AddScoped<IBookService, BookService>(); |
BookController:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
[Route("api/[controller]")] [ApiController] public class BookController : ControllerBase { private readonly IBookService BookService; public BookController(IBookService bookService) { BookService = bookService; } public ActionResult Get(string isbn) { var book = BookService.GetBookByISBN(isbn); return Ok(book); } } |
Book.API projesini startup as project yapıp api/book?isbn=test şeklinde bir url ile verilerimizin döndüğünü görebiliriz. Böylece kitap servimizi şimdilik tamamlanmış oluyoruz.
User servisimizde kitap servisindeki aynı mantıkla geliştireceğiz.Bu servisde kullanıcının username‘i parametremiz olacak.
Bu bölüm kitap servisinin neredeyse aynısı olduğu için sadece UserController ve IUserService’i göstereceğim
UserController:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
[Route("api/[controller]")] [ApiController] public class UserController : ControllerBase { private readonly IUserService UserService; public UserController(IUserService userService) { UserService = userService; } public ActionResult Get(string username) { var dto = UserService.GetUserByUsername(username); return Ok(dto); } } |
IUserService:
1 2 3 4 5 6 7 |
namespace User.Domain.Services { public interface IUserService { UserDTO GetUserByUsername(string username); } } |
1 2 3 4 5 6 7 8 9 10 11 |
namespace User.Domain.DTOS { public class UserDTO { public string Username { get; set; } public string Name { get; set; } public string Surname { get; set; } public DateTime? BirthDate { get; set; } public int? Age => BirthDate.HasValue ? DateTime.Now.Year - BirthDate.Value.Year : (int?)null; } } |
IUserService’i startup.cs’de bağlamayı ve projelerin referansını vermeyi unutmayınız. Bu işlemlerde bittikten sonra projemizi startup project yapıp api/user?username=okan şeklinde bir url ile testimizi yaptığımızda başarılı olduğunu görüyoruz. Servislerimiz bu noktada bitiyor şimdi gateway oluşturma kısmına geçelim.
Api Gateway
Öncelikle api gateway neden gerekli neden ihtiyaç duyuyoruz ona değinelim. Yaptığımız iki servis farklı portlarda belki de farklı makinelerde ayağa kalkacaktır. Client tarafında bu bilgileri beraber çağırma ihtiyacımız olabilir her sefereinde farklı portlara bağlanıp bunları birleştirmek servis sayısı arttıkça bu işlemi zorlaştıracaktır bunun yerine bütün servislerimizi tek noktadan yöneterek client tarafında aynı portla ile yönlendirmelerimizi sağlayabiliriz bunun dışında bu iki servisin bir authorize işlemi olabilir, her servisi yeniden authorize yapmak yerine gateway ile bu güvenli bir şekilde yapılabilir.
ApiGateway projemize açık kaynak kodlu Ocelot paketinden faydalanacağız nuget üzerinden yükleyelim.
Resmi dokümantasyonu takip edebiliriz link
Paketi yükledikten sonra APIGateway’in ana dizinine apiSettings.json adında bir configuration dosyası ekleyelim. Bu dosyada servislerimizin tanımlarını yapacağız.
Aşağıdaki şekilde json dosyamızı düzenliyoruz.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
{ "Routes" : [ { "DownstreamPathTemplate": "/api/book?isbn={isbn}", "DownstreamScheme": "https", "DownstreamHostAndPorts": [ { "Host": "localhost", "Port": 44365 } ], "UpstreamPathTemplate": "/book/{isbn}", "UpstreamHttpMethod": [ "Get" ] }, { "DownstreamPathTemplate": "/api/user?username={username}", "DownstreamScheme": "https", "DownstreamHostAndPorts": [ { "Host": "localhost", "Port": 44313 } ], "UpstreamPathTemplate": "/user/{username}", "UpstreamHttpMethod": [ "Get" ] } ] } |
Routes adında dizi tipinde bir nesnemiz var. Bu dizine servislerimizi kaydettik. Servisleri https protokolü üzerinden yayınladıkları ortları yazdık sizde kendi portlarınız yazınız. Downstream, bağlandığımız servisin bilgileri, Upstream ise gateway üzerinden çağırdığımız yani aslında kullandığımız port üzerinde hangi adresle tetikleneceğini belirledik.
Solution’ın properties’lerine girip startup project olarak apilerimizi ve gatewayi seçiyoruz.
Projemizi çalıştırıp belirlediğimiz url’ler ile dönen cevapları kontrol edelim.
Proje dosyalarına aşağıdaki linkten erişebilirsiniz.
Proje linki : https://github.com/okankrdg/ApiGatewayExample
Hocam Selamlar,
Book servisinde okan kitap aldı diye bir tabloda kitap ve kullanıcı Id lerini tutuyor diyelim.
Ve işlemler binlerce satırı buldu.
Book ve User ayrı Db’lerde diye düşünelim.
Şimdi datayı çoklayarak Book’ta user tablosu oluşturabilirim. Ya da sadece Id lerini tutarak BFF tarzı bir işlem yapabilirim.
Şimdi BFF yaptığımızı düşünelim Apigetaway’de yalnız yüz bin satır kitap ve yüz bin satır user datasını nasıl birleştirebiliriz.
Teşekkürler
Merhaba,
apiSetting.json dosyasında Routes gibi Aggregates adında bir dizi tanımlamalısınız,
ör:
"Aggregates": [, daha sonra yazılan UserBookAggregator’ü IDefinedAggregator’dan miras alarak yeni bir response dönderebilirsiniz. Daha fazla detay için resmi doküman da yardımcı olabilir{
"RouteKeys": [
"user",
"book"
],
"Aggregator": "UserBookAggregator",
"UpstreamPathTemplate": "/bookwithuser/{id}"
}
]