API Development: REST API Data Models Eğitimi

Eğitim Hakkında

REST API veri modellemesi ve uyumluluğu

Eğitim REST API'nin veri modelini odağa alır. JSON veri tipleri ve ISO 8601 tarih, JSON Schema ile doğrulama, DTO ayrımı ve mass assignment riski, HAL, JSON:API ve Siren karşılaştırması, OpenAPI şemaları, cursor sayfalama, kaynak sürümleme, problem+json hata modeli ve Postman ile şema bazlı sözleşme testi uygulamalı işlenir.

Süre ve Format

2 Gün. Her gün dört modül; 1. gün Veri Modeli, Sözleşme ve Koleksiyonlar; 2. gün Evrim, Hata ve Sözleşme Güvencesi.

Seviye

Orta Seviye — REST API veri modellemesi ve uyumluluğu

Öğrenme Metodu

Her konu, gerçek bir API üzerinde istek göndererek ve tasarım kararlarını tartışarak işlenir; katılımcılar OpenAPI tanımı yazıp Postman ve curl ile sonuçlarını doğrular.

Neden Bu Eğitim?

📐Tasarım Kuralları

HTTP semantiği, URI ve model kararlarını standartlara dayandırarak tutarlı API'ler tasarlarsınız.

🔍Canlı İnceleme

Gerçek istek ve yanıtları curl ve Postman ile inceleyerek teoriyi hemen pratiğe dökersiniz.

📄Sözleşme Odaklılık

OpenAPI ile yazılan sözleşme sayesinde ekipler arası uyumu ve dokümantasyonu otomatikleştirirsiniz.

Anahtar Konular

rest apirestful apiapi tasarımıopenapiswaggerhttp metotlarıjsonapi geliştirmeapi development: rest api data models

“Veri modeli, API'nin sözleşmesidir.”

Ön Koşullar

Eğitimden verim almak için faydalı olacak bilgi ve ortam gereksinimleri

1

Programlama Temeli

Herhangi bir dilde temel programlama bilgisi ve JSON okuyabilme becerisi yeterlidir.

2

Web Bilgisi

Tarayıcı, URL ve HTTP'nin kabaca nasıl çalıştığına dair temel fikir faydalıdır.

3

Araçlar

Postman, curl ve bir metin editörü (VS Code) kurulu bir bilgisayar gerekir.

4

Merak

Örnek API'ler üzerinde deneme yapmaya açık olmak yeterli ön koşuldur.

Eğitim İçeriği

Programın gün gün akışı aşağıdadır. Bir güne tıklayarak o günün modüllerini ve içeriklerini görebilirsiniz.

Günün hedefiKatılımcı gün sonunda REST API Veri Modelleri konusunu çalıştırır, OpenAPI ile Sözleşme ve Dokümantasyon ve Sayfalama, Filtreleme ve Sıralama ile ilerleyip Hipermedya ve HATEOAS kararlarını gerekçelendirir.

Modül 1

REST API Veri Modelleri

JSON veri tipleri, null / eksik alan ayrımı ve tarih için ISO 8601 / RFC 3339
JSON Schema ile doğrulama: required, enum, pattern, oneOf
DTO ile alan modeli ayrımı ve verinin aşırı açığa çıkmasının önlenmesi
HAL, JSON:API ve Siren gibi hipermedya biçimlerinin karşılaştırılması
Para birimi, zaman dilimi ve çok dilli metin için model kararları
XML, Protocol Buffers ve MessagePack temsillerinin JSON ile kıyaslanması

Modül 2

OpenAPI ile Sözleşme ve Dokümantasyon

OpenAPI 3.x yapısı: paths, components, schemas, parameters, responses
$ref ile yeniden kullanım, allOf / oneOf ve discriminator
securitySchemes: apiKey, http bearer, oauth2 ve openIdConnect
Swagger Editor ve Stoplight ile tasarım, Spectral ile kural tabanlı lint
openapi-generator ile sunucu iskeleti ve istemci SDK'sı üretimi
Örnek (example) alanları ve Redoc ile geliştirici dokümanı yayınlama

Modül 3

Sayfalama, Filtreleme ve Sıralama

Offset / limit ile cursor (keyset) sayfalama arasındaki performans farkı
Link başlığı (RFC 8288) ve next / prev bağlantıları
Filtre sözdizimi: eşitlik, aralık, arama ve çoklu değer
sort=-createdAt gibi sıralama parametreleri ve güvenli alan beyaz listesi
Alan seçimi (fields) ve ilişkili kaynakları genişletme (expand / include)
Toplam kayıt sayısının maliyeti ve X-Total-Count alternatifleri

Modül 4

Hipermedya ve HATEOAS

HATEOAS fikri: yanıt içinde durum geçişlerini bağlantı olarak sunma
Spring HATEOAS veya benzeri araçlarla bağlantı üretimi
Link ilişki türleri (rel) ve IANA kayıtlı değerler
Hipermedya ile istemci-sunucu bağımlılığının azaltılması
URI şablonları (RFC 6570) ve eylem keşfi
HATEOAS'ın pratik maliyeti ve kullanıldığı gerçek örnekler

Günün hedefiKatılımcı Sürümleme ve API Evrimi ve Hata Yönetimi ve Problem Details konularını uygulayarak API Öncelikli Tasarım Süreci ile API Sözleşme Testi adımlarını aynı örnek üzerinde birleştirir.

Modül 1

Sürümleme ve API Evrimi

Kırıcı (breaking) ve kırıcı olmayan değişikliklerin sınıflandırılması
URI, başlık (Accept vendor media type) ve sorgu parametresiyle sürümleme
Alan ekleme, alan kaldırma ve alan yeniden adlandırma stratejileri
Deprecation ve Sunset başlıkları (RFC 8594) ile emeklilik duyurusu
Tolerant reader ilkesi ve tüketici uyumluluğu
Sürümler arası kullanım izleme ve geçiş takvimi planlama

Modül 2

Hata Yönetimi ve Problem Details

RFC 9457 / 7807 application/problem+json yapısı: type, title, status, detail, instance
Doğrulama hatalarında alan bazlı hata listesi biçimi
4xx ile 5xx ayrımı: istemci hatası ile sunucu hatası sorumluluğu
Hata mesajlarında bilgi sızıntısını önleme (stack trace, SQL ifadesi)
İstek kimliği (correlation ID) ile hata yanıtlarının loglarla eşleştirilmesi
429 Too Many Requests ve Retry-After ile istemci geri çekilme (backoff) yönlendirmesi

Modül 3

API Öncelikli Tasarım Süreci

API-first ve code-first yaklaşımları: ekipler arası paralel çalışma avantajı
Kullanıcı yolculuğundan (user journey) kaynak ve işlem listesinin çıkarılması
Sözleşmeyi önce yazıp mock sunucudan istemci geliştirmeyi başlatma
Tasarım gözden geçirme (API review) oturumu ve stil rehberi oluşturma
Spectral kuralları ve CI içinde sözleşme lint'i
Breaking change tespiti için openapi-diff ve sözleşme sürüm kontrolü

Modül 4

API Sözleşme Testi

Sözleşme testi kavramı: sağlayıcı (provider) ve tüketici (consumer) beklentileri
OpenAPI şemasını Postman'a bağlayıp yanıt doğrulaması yapma
JSON Schema ile zorunlu alan, tip ve enum kontrolü
Geriye dönük uyumluluk bozan değişikliklerin tespiti
Pact ile tüketici güdümlü sözleşme testlerine karşılaştırma
Sözleşme testlerini CI hattına bağlayıp sürüm kapısı olarak kullanma

Eğitim Kazanımları

Program sonunda katılımcılar:

✅

Veri Modeli Tasarımı

JSON Schema ile doğrulanan, sürdürülebilir REST veri modelleri tasarlayabilirsiniz.

🧩

OpenAPI Sözleşmesi

OpenAPI ile makine okunur API sözleşmesi yazıp kod ve doküman üretebilirsiniz.

🔧

Koleksiyon Sorguları

Sayfalama, filtreleme ve sıralama uçlarını performanslı ve öngörülebilir şekilde tasarlayabilirsiniz.

📐

Hipermedya Tasarımı

Hipermedya bağlantılarıyla keşfedilebilir API yanıtları tasarlayabilirsiniz.

🛡️

API Evrimi

Kırıcı değişiklikleri yönetip API'nizi tüketicileri bozmadan geliştirebilirsiniz.

🧪

Hata Yönetimi

Tutarlı problem+json hata yanıtları üretip istemcilerin hatadan toparlanmasını kolaylaştırabilirsiniz.

🚀

API-First Çalışma

Sözleşmeyi koddan önce tasarlayan bir API-first iş akışını ekibinize uygulayabilirsiniz.

📊

Sözleşme Testi

API yanıtlarının sözleşmeyle uyumunu otomatik doğrulayan testler yazabilirsiniz.

Kimler İçin Uygundur?

API tasarlayan backend geliştiricileri
veri modelleyicileri
entegrasyon mimarları içindir

Sıkça Sorulan Sorular

Bu eğitim kimler için uygundur?

API tasarlayan backend geliştiricileri, veri modelleyicileri ve entegrasyon mimarları içindir.

Hangi dil ve çatı kullanılıyor?

Tasarım ilkeleri dilden bağımsızdır; uygulama örnekleri OpenAPI, Postman ve seçilen bir sunucu çatısı üzerinden gösterilir.

Hazır API mi kullanılacak, yoksa kendimiz mi yazacağız?

Her ikisi de; hazır genel API'lerle başlanır, ardından kendi örnek API'nizi tasarlayıp sözleşmesini yazarsınız.

Eğitim sonunda ne öğrenmiş olacağım?

Tutarlı bir REST API tasarlayıp OpenAPI ile belgeleyebilir, hata, sürümleme ve güvenlik konularında karar verebilirsiniz.

Sertifika veriliyor mu?

Evet, tamamlayan katılımcılara Digital Vizyon Akademi Katılım ve Başarı Sertifikası verilir.

Sertifikalandırma

Bu eğitim Digital Vizyon Akademi Başarı Sertifikası ile tamamlanır.

Eğitim başında “Ön Test”, bitiminde “Son Test” uygulanarak gelişim ölçümlenir. Değerlendirme formunu dolduran katılımcılar sertifikalarını alır. Sertifikanızın geçerliliğini Sertifika Sorgulama sayfasından doğrulayabilirsiniz.

Örnek Sertifika

API DEVELOPMENT: REST API DATA MODELS EĞİTİMİ