QA Shop API Sözleşmesi — Örnek Swagger / OpenAPI

QA Shop pratik ortamının REST API sözleşmesi: 46 uç, etiketlere ayrılmış, her ucun beklenen status kodlarıyla birlikte. Test case'lerini bu sözleşmeye göre yazarsın.

Gerçek bir REST API sözleşmesini baştan sona incele: etiketlere ayrılmış 46 endpoint, istek gövdeleri ve beklenen 401, 403, 409, 422 cevaplarıyla birlikte.

Sayfa sözleşmeyi build sırasında üretilen bir türevden okur; Docker kurulu olmasa da tüm uçları inceleyebilirsin. Ham openapi.yaml dosyasını Postman veya Swagger Editor'a aktarmak istersen yığının ayakta olması gerekir.

Bu sayfada neler öğreneceksin

  • Sistem uçları — Sağlık ve keşif GET /health — Servis ve veritabanı sağlığı · GET /api/v1/openapi.yaml — Bu sözleşmenin kendisi · GET /api/v1 — API keşif noktası
  • Sandbox uçları — İzole veri alanı yönetimi — aç, durum gör, sıfırla, log oku POST /api/v1/sandbox — Yeni izole veri alanı aç · GET /api/v1/sandbox/state — Satır sayıları · POST /api/v1/sandbox/reset — Seed veriye dön · GET /api/v1/sandbox/logs — Denetim kaydı (log analizi prat
  • Kimlik uçları — Kayıt, giriş, oturum POST /api/v1/auth/register — Yeni kullanıcı kaydı · POST /api/v1/auth/login — Giriş yap, token al · GET /api/v1/auth/me — 🔒 Oturumdaki kullanıcı · POST /api/v1/auth/logout — 🔒 Oturumu kapat · POST /api/v1/auth/refresh — 🔒 Token yenile
  • Katalog uçları — Ürün, varyant, kategori, marka, arama GET /api/v1/products — Ürün listesi · GET /api/v1/products/{id} — Ürün detayı · GET /api/v1/products/{id}/variants — Ürünün varyantları ve stoğu · GET /api/v1/categories — Kategori ağacı · GET /api/v1/categories/{id}/produ
  • Sepet uçları — Sepet ve satırları — stok rezervasyonu burada gerçekleşir POST /api/v1/carts — Sepet aç · GET /api/v1/carts/{id} — Sepet detayı ve toplamlar · POST /api/v1/carts/{id}/items — Sepete ürün ekle · PATCH /api/v1/carts/{id}/items/{itemId} — Satır adedini güncelle ·
  • Sipariş uçları — Checkout, listeleme, iptal, fatura, yaşam döngüsü (ödeme → kargo → teslim → iade) POST /api/v1/orders — 🔒 Checkout — sepeti siparişe çevir · GET /api/v1/orders — 🔒 Kendi siparişlerin · GET /api/v1/orders/{id} — 🔒 Sipariş detayı · POST /api/v1/orders/{id}/ca
  • Adres uçları — Adres defteri — varsayılan adres kuralı tek satırdan fazlasını etkiler GET /api/v1/addresses — 🔒 Adreslerim · POST /api/v1/addresses — 🔒 Adres ekle · PATCH /api/v1/addresses/{id} — 🔒 Adres güncelle · DELETE /api/v1/addresses/{id} — 🔒 Adres sil
  • Yorum uçları — Ürün yorumları ve moderasyon — onaysız yorum listede ve ortalamada görünmez GET /api/v1/products/{id}/reviews — Ürün yorumları · POST /api/v1/products/{id}/reviews — 🔒 Yorum yaz · GET /api/v1/products/{id}/rating — Ortalama puan ve dağılım · PATCH /api/v1/rev
  • Kusur uçları — Kontrollü bug anahtarları — testinin gerçekten kırmızıya döndüğünü kanıtlamak için GET /api/v1/sandbox/bugs — Açılabilecek kusurların kataloğu · PATCH /api/v1/sandbox/bugs — Kusur aç / kapat · POST /api/v1/sandbox/bugs/hidden — Gizli tur başlat · POST /api/v1/
  • Sözleşmedeki status kodları — Hata yolları 200 ile kapatılmaz. Sözleşmede geçen kodlar: 200, 201, 204, 400, 401, 402, 403, 404, 409, 410, 422, 503. 401 kimlik doğrulanmadı, 403 yetki yok, 409 durum izin vermiyor, 422 iş kuralı reddetti.