Gezen Backend Dokümantasyonu

Gezen Backend (Sword API) için açık dokümantasyon sitesine hoş geldiniz.

Bu site, kod tabanına doğrudan girmeden backend'i anlamak, kurmak ve bakımını yapmak isteyenler için hazırlanmıştır.

Burada neler var?

• Dağıtım rehberleri: üretim ve yerel HTTPS kurulumları
• Operasyon notları: ortam değişkenleri, loglar ve bakım
• Mimari ve analiz notları: teknik borç ve tasarım kararları

Hızlı bağlantılar

• Üretim Dağıtımı
• Yerel Dağıtım
• Kod Analizi
• Analiz Raporu
• Yük Testi

API referansı

Etkileşimli API referansı uygulamanın içinde kullanılmaya devam eder:

• Swagger UI: /api/docs
• ReDoc: /api/redoc

Dokümantasyona katkı

docs/ altındaki bir sayfayı güncellediğinizde değişiklikleri main dalına gönderin. GitHub Actions iş akışı siteyi derleyip GitHub Pages'e yayınlar.

Yerelde önizleme için:

pip install -r requirements/docs.txt && mkdocs serve