JSON Formatı
HTTP Metodları
OpenAPI Desteği
Esnek Yapılandırma
REST API Proxy Oluşturma Yöntemleri
REST API Proxy oluşturmak için birkaç yöntem mevcuttur:OpenAPI/Swagger Dosyasından Import
OpenAPI/Swagger Dosyasından Import
Manuel Oluşturma
Manuel Oluşturma
Mevcut API Proxy'den Kopyalama
Mevcut API Proxy'den Kopyalama
SOAP Web Servisinden REST API Proxy Oluşturma
SOAP Web Servisinden REST API Proxy Oluşturma
OpenAPI/Swagger Dosyasından Import
API Proxy Oluşturma Sayfasına Gidin
OpenAPI Dosyasını Yükleyin
Yöntem 1: URL'den Yükleme
Yöntem 1: URL'den Yükleme
https://petstore.swagger.io/v2/swagger.json) ve Parse butonuna tıklanır. Dosya parse edilir ve API bilgileri görüntülenir.Yöntem 2: Dosya Yükleme
Yöntem 2: Dosya Yükleme
Yöntem 3: Metin Olarak Yapıştırma
Yöntem 3: Metin Olarak Yapıştırma
API Bilgilerini Kontrol Edin
API Adı
Versiyon
Base URL
Endpoint'ler
Şemalar
Routing Yapılandırması
Client Route (Relative Path)
Client Route (Relative Path)
Upstream Target (Backend Address)
Upstream Target (Backend Address)
Tek Backend
Dinamik Backend
servers veya host bilgisinden otomatik olarak alınır.Örnek:API Proxy'yi Kaydedin
Desteklenen OpenAPI Versiyonları
Apinizer, aşağıdaki OpenAPI versiyonlarını destekler:- OpenAPI 2.0 (Swagger 2.0): Tam destek
- OpenAPI 3.0: Tam destek
- OpenAPI 3.1: Tam destek
OpenAPI 2.0 Özellikleri
swaggeralanı:"2.0"değerihost,basePath,schemesalanlarıpathsvedefinitionsyapısıparametersveresponsestanımları
OpenAPI 3.0/3.1 Özellikleri
openapialanı:"3.0.0"veya"3.1.0"değeriserversarray’ipathsvecomponentsyapısırequestBodyveresponsestanımlarısecuritySchemesvesecuritytanımları
Import Sonrası Yapılandırma
API Proxy oluşturulduktan sonra, aşağıdaki yapılandırmalar yapılabilir:HTTP Routing Yapılandırması
Politikalar Ekleme
Test Etme
Yükleme ve Sürüm
Yaygın Senaryolar
Senaryo 1: Public API'yi Proxy Etme
Senaryo 1: Public API'yi Proxy Etme
OpenAPI URL'sini Kullanın
Relative Path Belirleyin
/petstoreProxy).Upstream Target Ayarlayın
Kaydedin ve Deploy Edin
Senaryo 2: Internal API'yi Expose Etme
Senaryo 2: Internal API'yi Expose Etme
OpenAPI Dosyasını Yükleyin
Relative Path Belirleyin
Upstream Target Ayarlayın
Güvenlik Politikaları Ekleyin
Kaydedin ve Deploy Edin
Senaryo 3: API Versiyonlama
Senaryo 3: API Versiyonlama
Her Versiyon İçin Ayrı OpenAPI Dosyası
Farklı Relative Path'ler
/api/v1, /api/v2).Ayrı Politikalar
Geçiş Stratejisi
En İyi Uygulamalar
OpenAPI Dosyası Kalitesi
Relative Path Stratejisi
/{servis-adı}/{versiyon}Backend Adresi
Güvenlik Politikaları
Sorun Giderme
Import Hatası
Import Hatası
- OpenAPI dosyasının geçerli JSON veya YAML formatında olduğundan emin olun.
- OpenAPI versiyonunun desteklendiğinden emin olun.
- URL erişilebilirliğini kontrol edin.
- Dosya boyutunun limit içinde olduğundan emin olun.
Endpoint'ler Görünmüyor
Endpoint'ler Görünmüyor
- OpenAPI dosyasında
pathsalanının doğru tanımlandığından emin olun. - Endpoint’lerin
pathsaltında doğru şekilde tanımlandığını kontrol edin.
Routing Hatası
Routing Hatası
- Upstream Target adresinin doğru olduğundan emin olun.
- Backend API’nin erişilebilir olduğunu kontrol edin.
- HTTP Routing yapılandırmasını kontrol edin.
SOAP Web Servisinden REST API Proxy Oluşturma
SOAP protokolü ile geliştirilmiş bir Web Servisin REST olarak açılması talebi özellikle, var olan servislerin yeni geliştirilen mobil uygulamalar ya da JavaScript tabanlı Web uygulamaları tarafından kullanılması gibi durumlarda sıklıkla ortaya çıkmaktadır. Var olan servisin REST ile yeniden yazılması ya da metotlarını taklit eden yeni bir REST API geliştirilmesi seçenekleri zaman ve maliyet açısından etkin çözümler değildir. Apinizer, SOAP Web servislerin REST olarak açılmasını ve bunun için gerekli bütün dönüşümlerin konfigürasyonla yapılabilmesini sağlar.SOAP Web Servisten REST Tipinde API Proxy Oluşturma
WSDL Dosyasını Yükleyin

Protokol Dönüşümünü Seçin

Metot Dönüşüm Ayarları
API Proxy oluşturulduktan sonra, istenirse metotların istek ve yanıt mesajları için REST - SOAP mesaj yapıları arasında nasıl dönüşüm yapılacağı özelleştirilebilir. Bunun için API Proxy’nin Geliştirme (Development) sekmesine gidilir. Sol taraftaki metot listesinde Hepsi (All) seçiliyken, orta bölümde üstte istek ve altta yanıt mesajlarının dönüşüm ayarlarını açan simgeler görünür.


Dönüşüm Seçenekleri
Bir SOAP Servis istemcilere REST olarak açıldığı zaman istek ve yanıt mesajlarının dönüştürülmesi gerekir. İstemciden gelen JSON mesaj SOAP servise gönderilmeden önce XML mesajına, SOAP servisin döndürdüğü XML mesaj ise istemciye gönderilmeden önce JSON mesajına dönüştürülmelidir. Bu dönüşümün yapılabilmesi için çeşitli seçenekler bulunmaktadır:Jackson Transformation
JsonML Transformation
Template Message
İstek Mesajları Dönüşüm Seçenekleri
Bu bölümde istek mesajlarının dönüşüm seçeneklerinin detayları anlatılmaktadır.Jackson Dönüşümü Kullan (Use Jackson Transformation)

JsonML Dönüşümü Kullan (Use JsonML Transformation)

Şablon Mesajını Kullan (Use Template Message)

Yanıt Mesajları Dönüşüm Seçenekleri
Bu bölümde yanıt mesajlarının dönüşüm seçeneklerinin detayları anlatılmaktadır.Jackson Dönüşümü Kullan (Use Jackson Transformation)


