API Designer

API Designer Kavramı

API Designer, spec first yaklaşımı ile API geliştirme sürecini destekler. Bu yaklaşımda önce OpenAPI/Swagger spesifikasyonu oluşturulur, sonra bu spesifikasyondan API Proxy oluşturulur.

Spec First Yaklaşımı

OpenAPI/Swagger spesifikasyonu önce oluşturulur

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 Proxy Oluşturma

Spesifikasyondan API Proxy oluşturulur

OpenAPI spec'ten API Proxy oluşturma.

API Designer Ö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

Dokümantasyon Oluşturma

OpenAPI/Swagger spesifikasyonundan otomatik dokümantasyon oluşturma:

Otomatik Dokümantasyon

OpenAPI spec'ten otomatik dokümantasyon oluşturulur

• Spesifikasyondan dokümantasyon üretimi
• Markdown desteği
• Custom dokümantasyon ekleme

Dokümantasyon Önizleme

Oluşturulan dokümantasyon önizlenebilir

• Gerçek zamanlı önizleme
• Portal görünümü simülasyonu
• Dokümantasyon kalitesi kontrolü

Dokümantasyon Export

Dokümantasyon farklı formatlarda export edilebilir

• PDF export
• HTML export
• Markdown export

API Designer Kullanım Senaryoları

Spec first yaklaşımı ile API geliştirme senaryoları:

Spec First API Geliştirme

1. OpenAPI/Swagger spesifikasyonu oluşturma
2. Endpoint'leri ve schema'ları tanımlama
3. Spesifikasyonu doğrulama
4. Spesifikasyondan API Proxy oluşturma
5. Otomatik dokümantasyon oluşturma
6. API Portal'da yayınlama

Mevcut API Dokümantasyonu

1. Mevcut API'den OpenAPI spec oluşturma
2. Spesifikasyonu düzenleme ve güncelleme
3. Dokümantasyonu iyileştirme
4. Örnekler ve açıklamalar ekleme
5. Portal'da yayınlama

API Designer ve API Manager İlişkisi

API Designer, spec first yaklaşımı ile API Manager'a entegre çalışır. İşleyiş akışı:

API Designer
   │
   │ OpenAPI/Swagger Spec
   │ (Spec First)
   │
   ▼
API Manager
   │
   │ Spec'ten API Proxy Oluşturma
   │ Konfigürasyon
   │
   ▼
API Gateway

1. Spec Oluşturma

API Designer'da OpenAPI/Swagger spesifikasyonu oluşturulur

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

2. Spec Doğrulama

Spesifikasyon doğrulanır ve kontrol edilir

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

3. API Proxy Oluşturma

API Manager'da spesifikasyondan API Proxy oluşturulur

OpenAPI spec'ten otomatik olarak API Proxy oluşturulur.

4. Dokümantasyon ve Deployment

Dokümantasyon oluşturulur ve API deploy edilir

Otomatik dokümantasyon üretilir ve API Gateway'e deploy edilir.

bilgi

API Designer ve API Manager 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 Proxy ve dokümantasyon otomatik olarak üretilir.

API Designer 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

• Spesifikasyondan API Proxy 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

API Creator

API Creator bileşenini öğrenin

API Portal

API Portal bileşenini öğrenin

API Tasarımı

API tasarım kılavuzu

OpenAPI

OpenAPI kullanımı