Skip to content

EN Getting Started

Cavanshirpro edited this page Sep 19, 2026 · 1 revision

Getting started: purpose and products

English · Türkçe · Languages / Diller

Scope: JSON API Forge 0.5.1 · Source review: 17 September 2026 · Language: English

JSON API Forge is a server system built on FastAPI that expresses recurring backend tasks in numbered JSON documents. Resources, CRUD policies, database connections, SQL operations, authentication, caching and event channels are explicit configuration. Python hooks extend business logic that cannot be expressed clearly in JSON.

The goal is to make backend behavior visible, reduce repeated infrastructure code and support deployment on your own infrastructure. The application still owns its data model, authorization boundaries, business rules and deployment decisions.

Which component should I use?

Component Git branch Responsibility Runs a backend by itself?
Server/runtime main FastAPI application, CLI, schemas, databases and HTTP surfaces Yes, after creating an application
Python SDK python-library Sync/async requests, cluster routing and management clients No
Desktop Editor Editor C++20/Qt 6 JSON, visual form and graph editing No; the runtime runs separately
Example applications exampleApps 25 independent configuration projects With the main runtime

Branch names are case-sensitive: use Editor. These are separate product branches with their own files and CI workflows. They are not temporary feature branches awaiting a wholesale merge into main.

Suggested learning path

  1. Install the server and build your first API.
  2. Learn JSON merge rules, CRUD and the authorization model.
  3. Connect with the Python SDK or Editor.
  4. Use RPC and idempotency for multi-statement SQL work and hooks for custom logic.
  5. Before going live, follow production deployment, observability and known limits.

Three different versions

0.5.1 is the framework/SDK/Editor version. The version in app.json belongs to your application. The v1 in /api/my-service/v1 identifies your HTTP contract. Increasing one does not automatically change the others.

Source access and official distribution

The project is source-available. Public source visibility does not grant unrestricted redistribution rights. Official distribution is centralized; see license and contribution rules. This Wiki explains usage and does not replace the license.

Sources and verification

This page describes the behavior at the pinned commits below. Recheck these contracts when upgrading.


English home · All English pages · Version maintenance

Clone this wiki locally