API Development: REST API Semantics Eğitimi

Eğitim Hakkında

REST API'lerde metot ve yanıt anlamı

Eğitim REST API semantiğinin doğru uygulanmasını öğretir. Güvenli ve idempotent metotlar, PUT ile PATCH farkı, JSON Patch, 200/201/204/202/409/422/429 durum kodu seçimi, Location başlığı, ETag ve If-Match ile eşzamanlılık kontrolü, content negotiation, HATEOAS bağlantıları ve Postman ile semantik doğrulama testleri uygulamalı işlenir.

Süre ve Format

2 Gün. Her gün dört modül; 1. gün REST Kısıtları ve HTTP Semantiği; 2. gün Önbellek, Kaynak Tasarımı ve Doğrulama.

Seviye

Orta Seviye — REST API'lerde metot ve yanıt anlamı

Öğ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 semantics

“Doğru durum kodu, istemcinin yarı dokümantasyonudur.”

Ö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 Mimari İlkeleri konusunu çalıştırır, HTTP Metot ve Durum Kodu Semantiği ve Hata Yönetimi ve Problem Details ile ilerleyip Gelişmiş API Özellikleri kararlarını gerekçelendirir.

Modül 1

REST Mimari İlkeleri

Fielding'in altı kısıtı: istemci-sunucu, durumsuzluk, önbellek, tek tip arayüz, katmanlı sistem, isteğe bağlı kod
Kaynak (resource) odaklı düşünme ve temsil (representation) kavramı
Richardson Olgunluk Modeli seviye 0-3
Tek tip arayüz: kaynak tanımlama, temsil üzerinden manipülasyon, öz-açıklayıcı mesaj
Durumsuzluk (stateless) ve oturum bilgisinin istemcide veya token'da taşınması
REST ile RPC tarzı API'lerin karşılaştırılması

Modül 2

HTTP Metot ve Durum Kodu Semantiği

GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS metotlarının amaçları
Güvenli (safe) ve idempotent metot kavramı, PUT ile POST farkı
PATCH için JSON Patch (RFC 6902) ve JSON Merge Patch (RFC 7396)
2xx, 3xx, 4xx, 5xx durum kodu aileleri; 201 + Location, 204, 202 kullanımı
400, 401, 403, 404, 405, 409, 415, 422, 429 kodlarının doğru ayrımı
Content negotiation: Accept, Accept-Language ve 406 / 415 yanıtları

Modül 3

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 4

Gelişmiş API Özellikleri

Rate limiting algoritmaları: fixed window, sliding window, token bucket ve X-RateLimit başlıkları
Webhook tasarımı: imza doğrulama (HMAC), yeniden teslimat ve olay türleri
Uzun süren işlemler: 202 Accepted, durum kaynağı ve polling / callback
Idempotency-Key başlığı ile güvenli yeniden deneme
Toplu (bulk/batch) işlemler ve kısmi başarı yanıtları (207 Multi-Status)
Streaming: Server-Sent Events, WebSocket ve chunked transfer ile canlı veri

Günün hedefiKatılımcı HTTP Önbellekleme ve URI Tasarımı ve Kaynak Modelleme konularını uygulayarak Hipermedya ve HATEOAS ile Postman Test Betikleri ve Doğrulamalar adımlarını aynı örnek üzerinde birleştirir.

Modül 1

HTTP Önbellekleme

Cache-Control yönergeleri: max-age, s-maxage, no-store, no-cache, private, public
ETag ve If-None-Match ile koşullu GET, 304 Not Modified yanıtı
Last-Modified ve If-Modified-Since farkı
If-Match ile iyimser eşzamanlılık kontrolü ve 412 Precondition Failed
Vary başlığı ve CDN / ters vekil (Varnish, NGINX) önbelleği davranışı
Önbellek geçersizleştirme stratejileri ve stale-while-revalidate

Modül 2

URI Tasarımı ve Kaynak Modelleme

İsim tabanlı çoğul koleksiyon adları: /orders, /orders/{id}/items
İlişkili kaynaklar için iç içe yol ve sorgu parametresi tercihleri
Kaynak olmayan işlemler için eylem kaynakları (ör. /orders/{id}/cancellation)
Büyük/küçük harf, tire ve snake_case kuralları; sondaki eğik çizgi
Yol parametresi ile sorgu parametresi arasındaki ayrım ve filtre tasarımı
URI sürümleme ile başlık sürümlemenin kıyaslanması

Modül 3

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

Modül 4

Postman Test Betikleri ve Doğrulamalar

pm.test ve pm.expect (Chai) ile durum kodu, süre ve başlık doğrulamaları
pm.response.json() ile gövde alanı doğrulama ve JSON Schema (tv4/Ajv) kontrolü
Pre-request script ile dinamik veri, zaman damgası ve imza üretimi
Collection, folder ve request seviyesinde script kapsamı ve çalışma sırası
postman.setNextRequest ve pm.execution.setNextRequest ile akış kontrolü
Test sonuçlarında başarısızlık analizi ve flaky testlerin ayıklanması

Eğitim Kazanımları

Program sonunda katılımcılar:

✅

REST İlkeleri

REST kısıtlarını ve olgunluk modelini kullanarak bir API'nin tasarım kalitesini değerlendirebilirsiniz.

🧩

HTTP Semantiği

HTTP metotlarını ve durum kodlarını doğru semantikle kullanan uçlar tasarlayabilirsiniz.

🔧

Hata Yönetimi

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

📐

Gelişmiş Özellikler

Webhook, rate limit, idempotency ve uzun süren işlem kalıplarını API'nize ekleyebilirsiniz.

🛡️

Önbellek Yönetimi

ETag ve Cache-Control ile API yanıtlarını önbelleğe alıp tutarlılığı koruyabilirsiniz.

🧪

URI Tasarımı

Tutarlı, okunabilir ve genişletilebilir URI şemaları tasarlayabilirsiniz.

🚀

Hipermedya Tasarımı

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

📊

Postman Testleri

pm.test ile durum kodu, başlık ve gövde doğrulayan otomatik testler yazabilirsiniz.

Kimler İçin Uygundur?

API geliştiren yazılımcılar
API gözden geçirenler
test mühendisleri içindir

Sıkça Sorulan Sorular

Bu eğitim kimler için uygundur?

API geliştiren yazılımcılar, API gözden geçirenler ve test mühendisleri 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 SEMANTICS EĞİTİMİ