Allmine API

Migration doküman şablonu

Sıra 5~10 dkMobil / WebBackendKararlı

Entegrasyon ve client migration sayfaları için zorunlu bölüm yapısı

# Yeni migration sayfası — frontmatter örneği
---
title: "Özellik adı — platform migration"
description: "Ne değişti, kim etkilenir"
audience: [mobile]          # mobile | backend | ops (birden fazla olabilir)
status: stable              # stable | draft | deprecated
readingTime: 12             # tahmini dakika
---

Migration doküman şablonu

Yeni veya güncellenen migration rehberleri bu sırayı izler. Kopyalayıp kendi slug'unuz için doldurun.

1. Amaç

  • Hangi davranış değişti?
  • Hangi platformlar etkilenir (iOS, Android, web)?
  • Breaking change mi?

2. Önkoşullar

  • Minimum API / app sürümü
  • Gerekli auth scope veya feature flag
  • Bağımlı backend deploy'u

3. Endpoint

MethodGET
Path/api/v1/...
AuthBearer / @Public

Admin veya alternatif path varsa tabloda belirtin.

4. Request / Response

Request body, query ve başarılı response için örnek JSON veya TypeScript tipi.

{
  "isSuccess": true,
  "statusCode": 200,
  "data": {},
  "errors": [],
  "timestamp": "2026-05-22T10:00:00.000Z"
}

5. Hata kodları

HTTPNe zamanClient
400ValidationFormda errors göster
401TokenRefresh, sonra tek retry
409State uyumsuzEkranı yenile

6. Client adımları

Checklist (RTK Query tag'leri, socket subscribe, UI key extractor, vb.).

  1. Tip / schema güncelle
  2. API slice veya socket handler
  3. UI state ve test senaryoları

7. İlgili sayfalar

  • API Reference
  • Backend mimari sayfası (varsa)
  • İlgili sözleşme rehberi (Error Model, Pagination, …)

Politika: CONTENT_POLICY.md.

On this page