ZREST – SAP ABAP REST & OpenAPI Altyapısı

Çözdüğü Sorun

SAP tarafında bir REST servisi yazmak zor değil. Zor olan, o servisin kurum içinde anlaşılır ve kullanılabilir kalması.

Tipik senaryo şudur: e-ticaret ekibi bir entegrasyon için SAP'tan servis ister. ABAP tarafında servis yazılır. Sonra karşı tarafa hangi alanların gönderileceği Excel'de veya e-postada anlatılır. Bir alan eklenir, dokümantasyon güncellenmez. Yeni gelen bir geliştirici servisin ne döndürdüğünü öğrenmek için ABAP kodunu okumak zorunda kalır. Test için elle Postman koleksiyonu hazırlanır ve o da bir süre sonra bayatlar.

Sonuç: servis çalışıyordur ama kimse ondan emin değildir. Entegrasyon toplantılarının önemli bir kısmı "bu alan hâlâ geliyor mu?" sorusuna gider.

ZREST bu döngüyü kırmak için yazıldı: servis tanımı ile dokümantasyon aynı kaynaktan üretilir, dolayısıyla dokümantasyonun bayatlaması mümkün olmaz.

Öne Çıkan Özellikler

Etkileşimli Ürün Sunumu

Tarayıcıda çalışan sunum; ZREST mimarisini, gelen ve giden istek akışlarını, canlı SAP ekranlarını, üretilen OpenAPI ve Swagger arayüzünü, kayıtlı istek varyantlarını, log ve saklama ayarlarını, devreye alma adımlarını ve doğrulama kanıtlarını tek akışta anlatır.

Demo Ekranları

Aşağıdaki görüntüler çalışan ZREST demo servisinden ve SAP yönetim ekranlarından alınmıştır. Kullanıcı bilgisi anonimleştirilmiş veya kadraj dışında bırakılmıştır; lisans anahtarı ve gerçek müşteri verisi görüntülerde yer almaz.

Swagger arayüzü

Dokümantasyon arayüzü, açık kaynak Swagger UI bileşenini (SmartBear, Apache License 2.0) kullanır. Swagger, SmartBear Software Inc.'in tescilli markasıdır.

SAP yapılandırma ve izleme

Dokümantasyon Nasıl Çalışıyor?

Kullanıcı SAP sistemindeki dokümantasyon adresini açar. Sayfanın HTML'i ve arayüzün bütün CSS/JS dosyaları SAP sunucusunun kendi MIME deposundan servis edilir; sayfa açılırken tarayıcının Önder Yazılım'a bağlanması gerekmez. OpenAPI dokümanı da aynı SAP sunucusundan okunur.

1. Kullanıcı https://<sap-sunucunuz>/<SICF düğüm yolunuz>/swagger.html adresini açar.
2. SAP, arayüz dosyalarına işaret eden hafif bir HTML sayfası döner; sayfada satır içi (inline) çalıştırılabilir kod yoktur.
3. Arayüz, OpenAPI dokümanını aynı SAP sunucusundan okuyup servisleri listeler.
4. Sayfa açıldıktan sonra tarayıcı, kurulum bildirimi için Önder Yazılım'a tek yönlü bir istek gönderir. Bu isteğin sonucu okunmaz ve dokümantasyonu hiçbir şekilde etkilemez — aşağıda ayrıntılı anlatılır.

Bu kurgunun pratik faydası: sayfa, doküman ve arayüz dosyalarının tamamı aynı SAP sunucusunda barındığı için tarayıcı açısından tek bir kökendir. Basis ekibinizden CORS ayarı, ek başlık veya güvenlik istisnası istenmez — kurulumu geciktiren en yaygın kalem böylece devre dışı kalır.

Veri Güvenliği

Bir SAP servis dokümantasyonu, kurumun iş süreçlerinin haritasıdır. Bu yüzden ürünün en net taahhüdü şudur:

• Dokümantasyon ve arayüz dosyaları SAP sunucunuzdan gelir. Sayfayı açmak, düzenlemek veya "Try it out" ile denemek Önder Yazılım'a hiçbir istek göndermez.
• OpenAPI dokümanınız Önder Yazılım'a gönderilmez veya burada saklanmaz. Doküman SAP sunucusu ile kullanıcının tarayıcısı arasında kalır.
• İş verisi geçmez. "Try it out" istekleri ve iş verileri doğrudan tarayıcı ile SAP sunucusu arasında gider.
• Üçüncü taraf doğrulayıcı kapalıdır. OpenAPI dokümanınız veya servis adresiniz validator.swagger.io'ya hiç gönderilmez.
• Lisans kontrolü yoktur, yalnızca kurulum bildirimi vardır. Sayfa açıldıktan sonra tarayıcı Önder Yazılım'a tek yönlü, engelleyici olmayan bir bildirim gönderir (kapatılamaz, SAP tarafında bir ayarı yoktur). Bildirim; lisans anahtarınızı (varsa), sunucu adınızı, açılan servis yolunu ve paket sürümünü taşır. Referer, user-agent veya IP adresi toplanmaz. Sunucu adı ve servis yolu veritabanında şifreli tutulur; aranabilir dizin ayrı bir anahtarla üretilir ve geri açılamaz.
• Saklama ve iç bildirim: bildirim kayıtları 180 gün sonra otomatik silinir. Yeni bir kurulum ya da bir sorun (bilinmeyen lisans, host uyuşmazlığı, süre bitimi gibi) görüldüğünde Önder Yazılım'a otomatik bir e-posta gider; bu e-posta yukarıdaki bildirim alanlarını ve varsa eşleşen müşteri adını içerir, üçüncü bir hizmet sağlayıcıya gitmez. Ayrıntılar KVKK Aydınlatma Metni'nde yer alır.

Kurulum

Kurulum üç adımdır ve tamamı SAP tarafında yapılır:

1. Transport'u içe alın. ZREST paketi standart bir transport isteği olarak sisteminize aktarılır.
2. Servis düğümünü aktive edin. SICF üzerinden ilgili düğüm aktive edilir.
3. Lisans anahtarını girin. Size verilen anahtar, sisteme özel bir tabloya (SM30) girilir. DEV, QAS ve PRD kendi anahtarını kullanır; anahtar transport ile taşınmaz.

Lisanslama

ZREST lisanslı bir üründür. Lisans SAP sistemi bazındadır: her sistem (DEV / QAS / PRD) kendi anahtarını kullanır ve anahtar, tanımlandığı sunucu adına bağlıdır. Süre bitimine yaklaşıldığında dokümantasyon ekranında hatırlatma görünür; servisleriniz bundan etkilenmez.