Skip to content

Referans Proje

Cavanshirpro edited this page Sep 19, 2026 · 1 revision

ProjectConfig: bütün proje alanları

English · Türkçe · Languages / Diller

Kapsam: JSON API Forge 0.5.1 · İnceleme: 17 Eylül 2026 · Dil: Türkçe

Bu tablo sabit committeki Pydantic modeli ve JSON Schema’dan üretilmiştir. Kullanım açıklamaları: Proje ve JSON.

“Zorunlu” alanın JSON’da bulunma zorunluluğudur; null kabulü ayrı bir tür kuralıdır. Model() varsayılanı, ilgili modelin bu sayfalardaki varsayılanlarıyla oluşturulmasıdır. Boş liste/nesne varsayılanları her model için ayrı üretilir. —, varsayılan veya o sütunda şema sınırı olmadığını belirtir.

Tablodaki sınırlara ek olarak alanlar arası doğrulayıcılar vardır: izin/public seçimi, URL/host güvenliği, tenant/owner sütunları, cache/idempotency/transaction birlikteliği, şema çakışmaları ve güvenli regex bunlara dahildir. JSON Schema doğrulaması tek başına forge validate yerine geçmez. extra="forbid" nedeniyle bilinmeyen alanlar reddedilir.

ProjectConfig

Alan Tür Zorunlu Varsayılan Şema sınırları
slug string Evet — —
name string Evet — —
version string Hayır "0.5.1" —
enabled boolean Hayır true —
api_prefix string | null Hayır null —
docs_enabled boolean Hayır true —
audit_enabled boolean Hayır true —
cors_origins list[string] Hayır ["*"] —
cors_methods list[string] Hayır ["GET","POST","PUT","PATCH","DELETE","OPTIONS"] —
cors_headers list[string] Hayır ["Authorization","Content-Type","X-API-Key","Idempotency-Key","X-Request-ID"] —
cors_expose_headers list[string] Hayır ["X-Request-ID","X-Forge-Cache"] —
cors_allow_credentials boolean Hayır false —
cors_max_age_seconds integer Hayır 600 min=0; max=86400
databases dict[str, DatabaseConfig] Evet — —
mongo_databases dict[str, MongoDatabaseConfig] Hayır {} —
security SecurityConfig Hayır SecurityConfig() —
cache CacheConfig Hayır CacheConfig() —
rate_limit RateLimitConfig Hayır RateLimitConfig() —
protection ProtectionConfig Hayır ProtectionConfig() —
observability ObservabilityConfig Hayır ObservabilityConfig() —
realtime RealtimeConfig Hayır RealtimeConfig() —
roles dict[str, RoleConfig] Hayır {} —
resources list[ResourceConfig] Hayır [] —
mongo_resources list[MongoResourceConfig] Hayır [] —
operations list[OperationConfig] Hayır [] —
data_sources list[DataSourceConfig] Hayır [] —
dependencies list[DependencySpec] Hayır [] —
custom_endpoints list[CustomEndpointConfig] Hayır [] —
event_channels list[EventChannelConfig] Hayır [] —
webhook_docs list[WebhookDocConfig] Hayır [] —
media MediaConfig Hayır MediaConfig() —
features FeaturePacksConfig Hayır FeaturePacksConfig() —
project_dir string Hayır "" —
$schema string Hayır — Optional editor-only JSON Schema reference. Ignored by the runtime.

Manifest, fragment ve yükleme modeli

app.json manifesttir; config/*.json sıralı fragmentlerdir. manifest.schema.json ve fragment.schema.json dosyaları aynı büyük şemanın bu bağlama uygun alanlarını kullanır. Bir fragment tek başına tam ProjectConfig değildir. project_dir runtime tarafından proje dizinine bağlanır; taşınabilir config içinde makineye özel yol tutmayın. ForgeConfig, loader’ın birden çok ProjectConfig taşıyan iç modelidir.

Alan Tür Zorunlu Varsayılan Şema sınırları
name string Hayır "JSON API Forge" —
version string Hayır "0.5.1" —
projects list[ProjectConfig] Evet — —

Kaynak ve doğrulama

Bu sayfa aşağıdaki sabit commitlerdeki davranışı açıklar. Yeni bir sürümde aynı davranışın sürdüğünü varsaymayın.


Wiki ana sayfa · Tüm sayfalar · Sürüm ve bakım

Clone this wiki locally