API Proxy Tasarımı

Tasarım Sekmesi Kavramı

Tasarım sekmesi, API Proxy konfigürasyonunda spec first yaklaşımı ile API tasarımı, dokümantasyonu ve spesifikasyonu için araçlar sağlar. Bu sekmede seçilen API Proxy'nin metot/endpoint ve veri tiplerinin tanımları yönetilir. Yüklenerek kullanıma açılan bir API Proxy'nin API Tanım Dosyası bu tanımlamalar kullanılarak çalışma zamanında oluşturulur.

Spec First Yaklaşımı

OpenAPI/Swagger spesifikasyonu ile API tasarımı

API tasarımı spesifikasyon ile başlar.

Spesifikasyon Düzenleme

OpenAPI/Swagger spesifikasyonu düzenlenir

YAML/JSON formatında spesifikasyon oluşturma ve düzenleme.

Otomatik Dokümantasyon

Spesifikasyondan otomatik dokümantasyon oluşturulur

OpenAPI spec'ten dokümantasyon üretilir.

API Tanım Dosyası

Çalışma zamanında API Tanım Dosyası oluşturulur

Tanımlamalar kullanılarak API Tanım Dosyası üretilir.

bilgi

Tasarım sekmesinin içeriği ve kullanımı, Genel Bakış bölümünde birkaç detay verinin istenmiyor olması dışında Spec Tasarım Editörü arayüzü ile aynıdır.

uyarı

Tasarım sekmesi yalnızca Swagger 2.x, OpenAPI/Swagger 3.0.x ve No-Spec API tipindeki API Proxy'ler için kullanılabilir.

Tasarım Sekmesi Özellikleri

OpenAPI/Swagger Spesifikasyonu

Spec first yaklaşımında OpenAPI/Swagger spesifikasyonu oluşturma ve düzenleme:

OpenAPI Editor

• OpenAPI/Swagger editor
• YAML/JSON düzenleme
• Validation
• Syntax kontrolü

Schema Tasarımı

• JSON Schema tasarımı
• XML Schema tasarımı
• Data model tasarımı
• Request/Response schema'ları

Endpoint Tasarımı

• Endpoint tanımlama
• HTTP method belirleme
• Path parametreleri
• Query parametreleri

Metot ve Veri Tipi Tanımları

API Proxy'nin metot/endpoint ve veri tiplerinin tanımlarını yönetme:

Metot Tanımları

API Proxy metotlarının tanımları yönetilir

• HTTP metotları (GET, POST, PUT, DELETE vb.)
• Endpoint path'leri
• Parametre tanımları

Veri Tipi Tanımları

Veri tiplerinin tanımları yönetilir

• Request/Response modelleri
• Schema tanımları
• Veri yapıları

API Tanım Dosyası Oluşturma

Çalışma zamanında API Tanım Dosyası oluşturulur

• Tanımlamalardan otomatik üretim
• OpenAPI/Swagger formatı
• Portal entegrasyonu

Tasarım Sekmesi Kullanım Senaryoları

Spec first yaklaşımı ile API Proxy konfigürasyonu senaryoları:

Spec First API Proxy Konfigürasyonu

1. Tasarım sekmesinde OpenAPI/Swagger spesifikasyonu oluşturma
2. Endpoint'leri ve schema'ları tanımlama
3. Spesifikasyonu doğrulama
4. API Tanım Dosyası oluşturma
5. API Proxy'yi yükleme ve kullanıma açma

Mevcut API Proxy Güncelleme

1. Mevcut API Proxy'nin spesifikasyonunu düzenleme
2. Metot ve veri tipi tanımlarını güncelleme
3. Spesifikasyonu doğrulama
4. Güncellenmiş API Tanım Dosyası oluşturma
5. Değişiklikleri kaydetme

Tasarım Sekmesi ve Spec Tasarım Editörü İlişkisi

Tasarım sekmesi, Spec Tasarım Editörü ile aynı arayüzü ve özellikleri kullanır. İşleyiş akışı:

API Proxy Konfigürasyonu
   │
   │ Tasarım Sekmesi
   │ (Spec First)
   │
   ▼
Spec Tasarım Editörü
   │
   │ OpenAPI/Swagger Spec
   │ Metot/Endpoint Tanımları
   │ Veri Tipi Tanımları
   │
   ▼
API Tanım Dosyası
   │
   │ Çalışma Zamanında Oluşturma
   │
   ▼
API Proxy Deployment

1. Spesifikasyon Oluşturma

Tasarım sekmesinde OpenAPI/Swagger spesifikasyonu oluşturulur

Spec first yaklaşımı ile API tasarımı spesifikasyon ile başlar.

2. Spesifikasyon Doğrulama

Spesifikasyon doğrulanır ve kontrol edilir

OpenAPI standartlarına uygunluk kontrolü yapılır.

3. Metot/Endpoint Tanımlama

Metot ve endpoint tanımları yapılır

HTTP metotları ve path'ler tanımlanır.

4. API Tanım Dosyası Oluşturma

Çalışma zamanında API Tanım Dosyası oluşturulur

Tanımlamalardan otomatik olarak API Tanım Dosyası üretilir.

bilgi

Tasarım sekmesi ve Spec Tasarım Editörü arasındaki bu entegrasyon, spec first yaklaşımı ile API tasarımından deployment'a kadar kesintisiz bir süreç sağlar. Spesifikasyon önce oluşturulur, sonra bu spesifikasyondan API Tanım Dosyası otomatik olarak üretilir.

Tasarım Sekmesi Avantajları

Spec first yaklaşımının sağladığı avantajlar:

Spec First Yaklaşımı

• API tasarımı spesifikasyon ile başlar
• Standart OpenAPI/Swagger formatı
• Kod yazmadan API tasarımı

Otomatik Üretim

• Tanımlamalardan API Tanım Dosyası oluşturma
• Otomatik dokümantasyon üretimi
• Tutarlı API yapısı

Standart Uyumluluk

• OpenAPI/Swagger standartlarına uyum
• Interoperability
• Tool desteği

Güncel Dokümantasyon

• Spesifikasyondan otomatik dokümantasyon
• Dokümantasyon-spesifikasyon senkronizasyonu
• Portal entegrasyonu

Sonraki Adımlar

Genel Bilgi Sekmesi

API Proxy genel bilgileri

Settings

API Proxy ayarları

Endpoint Konfigürasyonu

REST endpoint konfigürasyonu

SOAP Metod Konfigürasyonu

SOAP metod konfigürasyonu

Spec Tasarım Editörü

Spec Tasarım Editörü detayları

API Designer

API Designer bileşenini öğrenin