Ana içeriğe git

API

ChurchApps API, her biri kendi veritabanına sahip altı veri modülüne hizmet veren tek bir kod tabanından oluşan modüler tek parça (modular monolith) bir mimaridir. Bu mimari, mikro hizmetlerin organizasyonel avantajlarını (net sınırlar, bağımsız veri depoları) tek bir dağıtımın işletimsel sadeliğiyle birleştirir.

Modüller​

ModülAmaç
MembershipKişiler, gruplar, haneler, izinler
AttendanceHizmetler, oturumlar, check-in kayıtları
ContentSayfalar, bölümler, öğeler, yayın
GivingBağışlar, fonlar, ödeme işleme
MessagingKonuşmalar, bildirimler, e-posta
DoingGörevler, planlar, atamalar

Teknoloji Yığını​

  • Çalışma zamanı: TypeScript (ES modülleri) ile Node.js 24.x
  • Çerçeve: Express
  • Bağımlılık Enjeksiyonu: Inversify (dekoratör tabanlı yönlendirme)
  • Veritabanı: MySQL -- modül başına bir veritabanı, her biri kendi bağlantı havuzuna sahip
  • Kimlik doğrulama: CustomAuthProvider aracılığıyla JWT tabanlı kimlik doğrulama
  • Dağıtım: Serverless Framework v3 ile AWS Lambda

Portlar​

ProtokolPortAçıklama
HTTP8084Ana REST API
WebSocket8087Gerçek zamanlı soket bağlantıları

Lambda Fonksiyonları​

AWS'ye dağıtıldığında API, altı Lambda fonksiyonu olarak çalışır:

  • web -- Tüm HTTP isteklerini işler
  • socket -- WebSocket bağlantılarını yönetir
  • timer15Min -- E-posta bildirimleri için her 30 dakikada bir çalışır (ad tarihseldir)
  • timerMidnight -- Özet e-postaları ve bakım görevleri için her gün çalışır
  • timerScheduledTasks -- Zamanı gelmiş otomasyonlar ve gecikmiş iş akışı işlemleri için her gün çalışır
  • timerWebhooks -- Kuyruğa alınmış giden webhook'ları iletmek için her dakika çalışır

Paylaşılan Kütüphaneler​

API, iki paylaşılan ChurchApps paketine bağlıdır:

  • @churchapps/helpers -- Temel yardımcı araçlar (DateHelper, ApiHelper vb.)
  • @churchapps/apihelper -- Kimlik doğrulama, veritabanı yardımcıları ve AWS entegrasyonları dahil Express sunucu yardımcı araçları
bilgi

API, ES modüllerini kullanır (package.json içinde "type": "module"). İçe aktarmalarınızın ES modül sözdizimini kullandığından emin olun.

Bu Bölümde​

  • Yerel Kurulum -- API'yi yerel olarak klonlayın, yapılandırın ve çalıştırın
  • Veritabanı -- Modül başına veritabanı mimarisi, şema betikleri ve veri erişim kalıpları
  • Modül Yapısı -- Denetleyiciler, depolar, modeller ve kimlik doğrulama
  • API Anahtarları -- Betikler ve bağlayıcılar için kişisel erişim belirteçleri
  • Bağlı Uygulamalar (OAuth) -- Üçüncü taraf uygulamalar için çok kiracılı OAuth akışı
  • Webhook'lar -- Olay bildirimlerini dış sistemlere iletin
  • MCP Sunucusu -- API'yi yapay zeka asistanlarına açan Model Context Protocol uç noktası
  • Uç Nokta Başvurusu -- Tüm modüller için eksiksiz REST API belgeleri