Giriş

Mirket, API yönetimi ürünüdür. Web uygulaması programlama arayüzleri (API’ler) oluşturma, yayınlama, kullanım ilkelerini uygulama, erişimi kontrol etme, abone topluluğunu besleme, kullanım istatistiklerini toplama ve analiz etme ve performans hakkında raporlama sürecidir . API Yönetimi bileşenleri, geliştirici ve api sağlayıcı topluluğunu desteklemek için mekanizmalar ve araçlar sağlar.

Modern yazılım mimarilerinden mikroservis mimarisi için API Gateway, istemcilerle backend servisleri / mikro servisler arasındaki API yönetimini sağlar. API Gateway, API isteklerini alarak çeşitli kurallara göre uygun servislere yönlendiren bir ters vekil sunucusu (reverse proxy) olarak çalışır.

Mirket ürünü aşağıdaki bileşenlerden (2.2) oluşmaktadır. Bileşen özellikleri versiyonlara göre güncellenip, değişebilir. Değişimler majör olmadıkça geriye dönük desteklenmektedir. Her versiyon güncellemesi öncesi, sürüm notu paylaşılır.

Majör değişikliklerde geriye dönük destek sağlanmamaktadır.

Versiyon değişiklik yöntemi (semantik versiyonlama yöntemi uygulanmaktadır)

  • Major : 1.0.0 → 2.0.0

  • Minor : 1.0.0 → 1.1.0

  • Patch : 1.0.0 → 1.0.1

4.9.X (Güncel = 4.9.2)

Özellikler

  • Kısmi Katalog Export / Import özelliği

    • API

    • Veri Kaynakları

    • Ortak Kodlar

    • Özellik Tanımları

  • Zamansal limit özelliği

    • Sistem Geneli

    • API Kullanıcıları

    • API

İyileştirmeler

  • Ortak Kodların API' lerden Filtrelenmesi

  • API' ye Yönlendirme Tipi Filtresi Eklenmesi

  • Özellik Tanımlarının Arama Filtresi Olarak API

  • API Kullanıcısı Ekranlarına Getirilmesi

  • API Tanımla Sayfasından Ayrılma Durumunda Uyarı Verilmesi

  • Cache yüklenme zamanı (%50 zamansal kazanım)

  • Cache güncelleme politikası güncellendi (%50 cache güncelleme zamansal kazanım)

  • API → Tanım tabında → Zamansal API Kısıtlama özelliği, İstek Kuralları Tabı içerisinde yatay tab olarak taşındı.

  • i18n → Uyarı mesajları/etiketler/butonların içeriklerinin iyileştirmesi

  • API Kullancısı → Kısıtlamalar tabı eklendi (IP Blacklist, Whitelist ve Zaman limit özellikleri tab altına taşındı)

  • API Kullanıcı Doğrulama Yöntemi (XPath ve JSON Path seçildiğinde informatif bilgilendirme tooltipler eklendi)

Hatalar

  • Backup sayfasından yedeklenmiş dump, restore işlemi hatalı path’e bakıyordu, dışarıdan dump import sürecinden ayrıştırıldı

  • API Cache : Response Header Content Accept Header, * (hepsi) ve Date değeri dinamik anlık zaman olarak set edilecek şekilde değiştirildi.

  • Yeni API Oluşturulurken API sayfasından ayrılınca uyarı popup çıkıyordu.

  • API → Edit Sayfası → Dönüşüm Tab’ı içindeki Header eklendiğinde sil butonun ikon düzeltmesi

  • Backup → Restore işleminde mevcut datanın üzerine yazacak strateji ile çalışıyordu. Mükerrer data import sebebiye veriyordu. Önceki collection drop, yenisini import şeklinde iyileştirme yapıldı. (DB restore process)

Kaldırılan Özellikler

  • Anonim yetkilendirme özelliği

Bileşenler

Ağ Geçidi (Gateway) : API ön ucu görevi gören, API isteklerini alan, kısıtlama ve güvenlik ilkelerini uygulayan, istekleri arka uç hizmetine iletir ve ardından yanıtı istek sahibine geri iletir. Ağ geçidi istekleri ve yanıtları anında düzenlemek ve değiştirmek için bir dönüştürme motoru içerir(versiyon 4.x.x ile birlikte). Ağ geçidi, analitik verileri periyodik olarak toplar ve önbelleğe alma sağlama gibi işlevler de sağlayabilir. Ağ geçidi, kimlik doğrulama, yetkilendirme, güvenlik, denetim ve mevzuat uyumluluğunu desteklemek için işlevsellik sağlar.

Katalog : API sağlayıcılarının, API’leri tanımlamak, API belgeleri oluşturmak, API’ler için erişim ve kullanım politikaları aracılığıyla API kullanımını yönetmek, güvenlik testi dahil olmak üzere API’nin yürütülmesini test etmek ve hata ayıklamak için kullandığı araçlar topluluğu ve test paketleri oluşturma, API’leri üretim, hazırlama ve kalite güvence ortamlarına dağıtma ve genel API yaşam döngüsünü koordine etme işlemleri yapılabilir.

UI : Operasyon / Geliştirici /API Kaynakları : Katalog işlemlerinin arayüzüdür. API kullanıcıları için belgeler, öğreticiler, örnek kod, etkileşimli bir API konsolu, İstemci Kimliği gibi kullanıcı anahtarlarını alınması işlemleri yapılır.

Raporlama ve analitik : API kullanımını ve yükünü (genel isabetler, tamamlanan işlemler, döndürülen veri nesnesi sayısı, işlem süresi ve tüketilen diğer dahili kaynaklar, aktarılan veri hacmi) izleme işlevinin yakın gerçek zamanlı yada periyodik olarak raporlanmasını sağlar. Raporlama ve analitik işlevselliği tarafından toplanan bilgiler, API sağlayıcısı tarafından bir kuruluşun genel sürekli iyileştirme süreci içinde API teklifini optimize etmek ve API’ler için yazılım Hizmet Düzeyi Sözleşmelerini tanımlamak için kullanılabilir.

Hazelcast : Dağıtık hesaplama, ön bellek/local bellek, kilitleme, kuyruklama işllemleri için kullanılır.

Notifikasyon : Asenkron API lerin, uç sistemden alınan bilgileri, hedef sistemlere http rest bildirimler çıkar.

Veritabanı : Katalog, konfigürasyon ve metik bilgilerini deplomaktan sorumludur.

(Opsiyonel) Ödeme : Ticari API’lere erişim için ücretlendirmeyi destekleyen işlevselliktir. Bu işlevsellik, kullanıma, yüke ve işlevselliğe dayalı olarak fiyatlandırma kurallarının ayarlanması, ilgili ödeme kanalına göre entegre edilmesi, CDR üretilmesi desteği içerebilir. Kuruma göre ödeme yöntemleri/akışları özel olarak geliştirilir.

Yazılım Mimarisi

Mirket Yazılım Mimarisi
Figure 1. Mirket Janissary Mimari

Yol Haritası

  • 5.X.X Özellikler (Major)

    • Arayüzlerin daha kullanıcı dostu hale getirilmesi

    • Multi tenant özelliği

    • Tenant bazlı tüm yetkinliklerin ayrıştırılması

    • Tenant bazlı veritabanın ayrıştırılması

    • Tenant bazlı loglamanın ayrıştırılması

    • Tenant bazlı kaynak ayrıştırılması

    • Tenant bazlı konteyner trafiğinin ayrıştırılması

    • Public API Portal

    • AI desteği (katalog, custom code generation)

  • 4.10.X Planlanan Özellikler (Minor)

    • JWT Yetkinliği (Beta sürüm)

    • Hassas verinin maskelenmesi

    • Gateway hatalarından alarm oluşturma özelliği

    • Mantıksal API Grup özelliği

    • API bazlı healtcheck

    • Asteriks(*) bazlı basit yönlendirme özelliği

  • 4.9.2 = Mevcut Özellikler

    • Arayüzden DB restore özelliği

    • Arayüzden ve Otomatik olarak DB backup özelliği

    • Kısmi Katalog Export / Import

    • Verimerkezleri arası katalog veri senkronizasyonu özelliği

    • API - Kullanıcı Doğrulama (Header, Basic, QueryString, Request Body gibi)

    • API - Kullanıcı yetkilendirme

    • API ve API Kullanıcılar üzerinde Beyaz/Kara list bazlı IP kısıtlama, Zaman bazlı erişim kısıtlamaları

    • REST + SOAP API desteği

    • API ve API kullanıcısı bazlı istatistikleri tutma ve grafik olarak gösterme

    • Anlık istatistik hesaplama ve near real-time gösterim

    • İstek / Cevap dönüşümleri

    • API, API Kullanıcı bazlı rate limit, API bazlı throttling

    • Basit, Roud Robbin (Load Balancing), Custom (Groovy, JS Function) yönlendirmeler

    • Dinamik/Statik merkezi konfigürasyonlar

    • Rol bazlı yetkilendirilmiş portal

    • Veri kaynağının servis olarak sağlanması (rdbms : oracle, mysql, mssql, postgresql, no-sql : mongo, cassandra)

    • Asenkron API özelliği (kısıtlı kullanım)

    • Notifikasyon özelliği

    • Çoklu veri kaynağının birleştirilmesi (composite-api)

    • Özellik bazlı yük dağılımı

    • Operasyon / Geliştirici için zenginleştirilmiş online / offline doküman

    • Geliştirici için api test özelliği

    • Cache özelliği

    • Kural bazlı api alarm üretilmesi özelliği

    • Örnek kod üretilmesi özelliği

    • Sistem, API bazlı log yönetimi özelliği

    • Özel hata kodları özelliği

    • API bazlı kural özelliği

    • Dinamik kod yazımı özelliği (javascript, groovy)

    • Organizasyon bazlı izole ortak kod/fonksiyon çağırma özelliği

    • IDM Entegrasyonu

    • SIEM loglama

    • Çoklu domain desteği

    • Konteyner DB (MongoDB)

    • Mikroservis mimarisi

    • Altyapı desteği (Docker, Kubernetes, Openshift)