Agent skill · software engineering · affaan-m
api-design
REST API tasarım kalıpları; kaynak isimlendirme, durum kodları, sayfalama, filtreleme, hata yanıtları, versiyonlama ve üretim API'leri için hız sınırlama içerir.
Why this skill is useful
Provides specific REST API design patterns and conventions that the AI wouldn't reliably generate on its own.
What it needs
About 6k tokens when loaded. Last updated 2026-08-06. 238,342 stars on the source repository.
What this skill does
API Tasarım Kalıpları Tutarlı, geliştirici dostu REST API'leri tasarlamak için konvansiyonlar ve en iyi uygulamalar. Ne Zaman Aktifleştirmeli Yeni API endpoint'leri tasarlarken Mevcut API sözleşmelerini incelerken Sayfalama, filtreleme veya sıralama eklerken API'ler için hata işleme uygularken API versiyonlama stratejisi planlarken Halka açık veya iş ortağı odaklı API'ler oluştururken Kaynak Tasarımı URL Yapısı İsimlendirme Kuralları HTTP Metodları ve Durum Kodları Metod Semantiği Metod Idempotent Güvenli Kullanım Amacı -------- ----------- ------ --------- GET Evet Evet Kaynakları getir POST Hayır Hayır Kaynak oluştur, aksiyonları tetikle PUT Evet Hayır Kaynağın tam değişimi PATCH Hayır Hayır Kaynağın kısmi güncellemesi DELETE Evet Hayır Kaynağı kaldır PATCH uygun implementasyonla idempotent yapılabilir Durum Kodu Referansı Yaygın Hatalar Yanıt Formatı Başarı Yanıtı Koleksiyon Yanıtı (Sayfalama ile) Hata Yanıtı Yanıt Zarfı Varyantları Sayfalama Offset-Tabanlı (Basit) Artıları: Uygulaması kolay, "N sayfasına git" destekler Eksileri: Büyük offset'lerde yavaş (OFFSET 100000), eş zamanlı eklemelerde tutarsız Cursor-Tabanlı (Ölçeklenebilir) Artıları: Pozisyondan bağımsız tutarlı performans, eş zamanlı eklemelerde kararlı Eksileri: Rastgele sayfaya atlayamaz, cursor opak Hangisi Ne Zaman Kullanılmalı Kullanım Senaryosu Sayfalama Tipi ---------- ---------------- Admin panelleri, küçük veri setleri (<10K) Offset Sonsuz kaydırma, akışlar, büyük veri setleri Cursor Halka açık API'ler Cursor (varsayılan) ile offset (opsiyonel) Arama sonuçları Offset (kullanıcılar sayfa numarası bekler) Filtreleme, Sıralama ve Arama Filtreleme Sıralama Tam Metin Arama Seyrek Fieldset'ler Kimlik Doğrulama ve Yetkilendirme Token-Tabanlı Auth Yetkilendirme Kalıpları Hız Sınırlama Header'lar Hız Limit Katmanları Katman Limit Pencere Kullanım Senaryosu ------ ------- -------- ---------- Anonim 30/dk IP Başına Halka açık endpoint'ler Kimlik Doğrulanmış 100/dk Kullanıcı Başına Standart API erişimi Pr …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills affaan-m/api-design--ebf0ea