SDK Kurulum

Python SDK kurulumu ve istemci seçimi

English · Türkçe · Languages / Diller

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

Paket adı json-api-forge-client, import adı json_api_forge olur. Sunucu paketi json-api-forge ile farklıdır. SDK'yı kurmak HTTP sunucusu, veritabanı veya Editörü kurmaz.

Sabit commit ile kurulum

python -m venv .venv
# Linux/macOS: source .venv/bin/activate
# Windows: .\.venv\Scripts\Activate.ps1
python -m pip install "json-api-forge-client @ git+https://github.com/YoungLionOrganization/JSON-API-Forge.git@9507fa902838f66400a603cea22b271a79d4eb9c"
python -c "import json_api_forge; print(json_api_forge.__version__)"

Geliştirme için python-library dalı, yeniden üretilebilir uygulama dağıtımı için commit tercih edilir. v0.5.1 Git etiketi server'a işaret eder; SDK kurulumunda onu kullanmak farklı paketi seçebilir. Public registry'de yayımlanmış olduğunu varsayarak çıplak paket adına güvenmek yerine doğrulanmış resmi dağıtım yolunu kullanın.

Python metadata'sı >=3.10, resmi test kapsamı 3.10–3.14'tür. Ana bağımlılık httpx; YoungLion/DDM opsiyoneldir. Pure Python wheel sözleşmesi py3-none-anydir.

İstemci tablosu

Sınıf	Kullanım
ForgeClient	Senkron uygulama API'si
AsyncForgeClient	asyncio uygulama API'si
ForgeCluster	Çok endpoint, routing/failover, sync bulk
AsyncForgeCluster	Async routing ve sınırlı concurrent bulk
EditorControlPlaneClient	Ekip/doküman yönetimi
AsyncEditorControlPlaneClient	Aynı yönetim API'sinin async istemcisi

Normal uygulama API key'i control plane login'in yerine kullanılamaz. İstemciyi kullanım ömrü boyunca paylaşmak bağlantı havuzunu kullanır; her istekte tekrar kurmak bağlantı maliyetini artırır. Kapanışta context manager veya close/aclose kullanın.

Base URL sözleşmesi

Helper'lar /api/<slug>/v1/... yolunu kurar. Bu yüzden tipik base URL https://api.example.com, proje argümanı wiki-demo olur. Base URL'ye ayrıca /api/wiki-demo/v1 ekleyip aynı helper'ı çağırmayın.

Özel API prefix'i veya farklı method/path kullanıyorsanız request() ile gerçek göreli yolu gönderin. Control plane client'ı kendi /__forge/editor/v1 yollarını kurar; ona da sunucu origin/deployment base'i verin.

Remote HTTP reddedilir. allow_insecure_http=True yalnız loopback geliştirmede HTTP'ye izin verir; LAN IP'sini veya genel hostu insecure moda açmaz. URL'ye gömülü kimlik bilgileri, fragment, traversal ve başka origin'e absolute request yolları reddedilir.

Release ayrıntısı

İncelenen v0.5.1 release'te SDK wheel adı py3-none-any_lib.whl olarak görünmektedir; bu, projenin beklenen py3-none-any sözleşmesiyle aynı değildir. Bu Wiki kurulumu sabit SDK commitini kullanır. Platform tag hatasında Python sürümünüzü rastgele değiştirmeden varlık adını ve doğru sdist/source seçimini inceleyin.

Tam constructor/metot imzaları: SDK referansları.

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.

• python-library/pyproject.toml
• python-library/json_api_forge/__init__.py
• python-library/json_api_forge/client.py

---

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