# APIZIT Linking

> Python APIs with clear context for AI. Write and test ordinary functions,
> define HTTP separately, and trace a route back to Python source.

Current documented version: 1.0.1, verified stable release.
Preceding stable public beta: 0.5.0. Python 3.10–3.14. Apache-2.0.

    python -m pip install "apizit-linking[preview,models]==1.0.1"
    apizit-linking validate . --json
    apizit-linking preview . --port 8080

Choose Linking for unchanged libraries, a separate inspectable HTTP manifest,
direct Python tests and controlled agent-assisted changes. Optional typed models,
HTTP/error policy, providers and guards support persistent protected JSON APIs.
Applications own storage, identity policy, backups and production deployment.
There is no portable streaming/WebSocket contract or execution sandbox.

## Start and verify

- Home: https://chipsi44.github.io/apizit-linking-examples/
- Quickstart: https://chipsi44.github.io/apizit-linking-examples/quickstart/
- Existing library: https://chipsi44.github.io/apizit-linking-examples/guides/turn-python-library-into-api-with-yaml/
- Models and permissions with SQLite: https://chipsi44.github.io/apizit-linking-examples/guides/persistent-api/
- Assistant workflow: https://chipsi44.github.io/apizit-linking-examples/guides/ai-assisted-development/
- Log to Python and controlled fix: https://chipsi44.github.io/apizit-linking-examples/guides/trace-route-to-python/
- Standalone serving: https://chipsi44.github.io/apizit-linking-examples/guides/standalone-serving/
- Manifest: https://chipsi44.github.io/apizit-linking-examples/reference/linking-yaml/
- CLI inspection and diff: https://chipsi44.github.io/apizit-linking-examples/reference/cli/
- Models: https://chipsi44.github.io/apizit-linking-examples/reference/models/
- HTTP responses: https://chipsi44.github.io/apizit-linking-examples/reference/responses/
- Resources and permissions: https://chipsi44.github.io/apizit-linking-examples/reference/resources-and-permissions/
- Schema: https://chipsi44.github.io/apizit-linking-examples/schema/apizit-linking-v1.schema.json
- Current limits: https://chipsi44.github.io/apizit-linking-examples/limits/#choose
- Compatibility: https://chipsi44.github.io/apizit-linking-examples/reference/compatibility/
- Flask comparison: https://chipsi44.github.io/apizit-linking-examples/comparisons/flask/
- FastAPI comparison: https://chipsi44.github.io/apizit-linking-examples/comparisons/fastapi/
- Releases: https://chipsi44.github.io/apizit-linking-examples/releases/
- Candidate: https://chipsi44.github.io/apizit-linking-examples/releases/1.0.0/
- Migrations: https://chipsi44.github.io/apizit-linking-examples/migrations/
- 0.5 to 1.0: https://chipsi44.github.io/apizit-linking-examples/migrations/0.5-to-1.0/
- Private security reporting: https://chipsi44.github.io/apizit-linking-examples/security/

Manifest v1 retains existing meanings; optional typed validation is explicit.
Runtime artifact v2 requires its exact compiling engine. Regenerate on upgrade.
Static validate/routes/explain/export do not import business code; --resolve-models
explicitly prepares imports and the factory. Contract diff is conservative and
cannot prove business behavior. Run direct and HTTP tests as well.

PyPI is canonical for package files: https://pypi.org/project/apizit-linking/
Examples: https://github.com/chipsi44/apizit-linking-examples
Public issues: https://github.com/chipsi44/apizit-linking-examples/issues
The examples repository does not publish engine GitHub Releases.

## Dated preceding release evidence

- 0.4 retrospective: https://chipsi44.github.io/apizit-linking-examples/releases/0.4.0/
- 0.5 release: https://chipsi44.github.io/apizit-linking-examples/releases/0.5.0/
- Old migration: https://chipsi44.github.io/apizit-linking-examples/migrations/0.3-to-0.4/
- Old migration: https://chipsi44.github.io/apizit-linking-examples/migrations/0.4-to-0.5/

Historical 0.5 installation: apizit-linking[preview]==0.5.0.
Under that legacy release, Response annotations are documentary only. Its
publication completed nine gated jobs including six clean-wheel smokes. Its
separate APIZIT integration recorded 12 Linking tests, 89 backend tests,
anti-vendoring checks and main-branch CI is green in that dated record.
Those observations do not prove the current registry or hosting state.

## Consultation and search

Markdown and this optional index help compatible agents consult documentation.
Google ignores llms.txt; there is no ranking guarantee. No measured token,
generation-speed or reliability gain is claimed. Flask and FastAPI can also
organize service code separately. APIZIT dev remains protected and noindex;
GitHub Pages is the public documentation during the transition.

## Documentation pages and Markdown

- [Python APIs with clear context for AI](https://chipsi44.github.io/apizit-linking-examples/markdown/index.md)
- [From plain Python to local HTTP](https://chipsi44.github.io/apizit-linking-examples/markdown/quickstart.md)
- [Build a Python API with an AI assistant](https://chipsi44.github.io/apizit-linking-examples/markdown/guides/ai-assisted-development.md)
- [Trace an HTTP route back to Python](https://chipsi44.github.io/apizit-linking-examples/markdown/guides/trace-route-to-python.md)
- [Build a persistent API with models and permissions](https://chipsi44.github.io/apizit-linking-examples/markdown/guides/persistent-api.md)
- [Serve Linking independently of APIZIT](https://chipsi44.github.io/apizit-linking-examples/markdown/guides/standalone-serving.md)
- [Keep HTTP outside the business code](https://chipsi44.github.io/apizit-linking-examples/markdown/guides.md)
- [Expose a Python function as an HTTP API without decorators](https://chipsi44.github.io/apizit-linking-examples/markdown/guides/expose-python-function-as-http-api-without-decorators.md)
- [Keep Python business logic independent from FastAPI](https://chipsi44.github.io/apizit-linking-examples/markdown/guides/keep-python-business-logic-independent-from-fastapi.md)
- [Turn a Python library into an API with YAML](https://chipsi44.github.io/apizit-linking-examples/markdown/guides/turn-python-library-into-api-with-yaml.md)
- [Forkable example APIs](https://chipsi44.github.io/apizit-linking-examples/markdown/examples.md)
- [V1 limits and boundaries](https://chipsi44.github.io/apizit-linking-examples/markdown/limits.md)
- [APIZIT Linking vs Flask: choose your HTTP boundary](https://chipsi44.github.io/apizit-linking-examples/markdown/comparisons/flask.md)
- [APIZIT Linking vs FastAPI: choose your API contract](https://chipsi44.github.io/apizit-linking-examples/markdown/comparisons/fastapi.md)
- [Linking YAML reference](https://chipsi44.github.io/apizit-linking-examples/markdown/reference/linking-yaml.md)
- [Typed request and response models](https://chipsi44.github.io/apizit-linking-examples/markdown/reference/models.md)
- [HTTP responses and business errors](https://chipsi44.github.io/apizit-linking-examples/markdown/reference/responses.md)
- [Resources, permissions and application lifecycle](https://chipsi44.github.io/apizit-linking-examples/markdown/reference/resources-and-permissions.md)
- [Validate and preview projects](https://chipsi44.github.io/apizit-linking-examples/markdown/reference/cli.md)
- [Compatibility policy](https://chipsi44.github.io/apizit-linking-examples/markdown/reference/compatibility.md)
- [Release notes](https://chipsi44.github.io/apizit-linking-examples/markdown/releases.md)
- [APIZIT Linking 0.4.0](https://chipsi44.github.io/apizit-linking-examples/markdown/releases/0.4.0.md)
- [APIZIT Linking 0.5.0](https://chipsi44.github.io/apizit-linking-examples/markdown/releases/0.5.0.md)
- [Migration guides](https://chipsi44.github.io/apizit-linking-examples/markdown/migrations.md)
- [Migrate from 0.3 to 0.4](https://chipsi44.github.io/apizit-linking-examples/markdown/migrations/0.3-to-0.4.md)
- [Migrate 0.4.0 to final 0.5.0](https://chipsi44.github.io/apizit-linking-examples/markdown/migrations/0.4-to-0.5.md)
- [Security policy](https://chipsi44.github.io/apizit-linking-examples/markdown/security.md)
- [APIZIT Linking questions, answered](https://chipsi44.github.io/apizit-linking-examples/markdown/faq.md)
- [Linking 1.0 stable release](https://chipsi44.github.io/apizit-linking-examples/markdown/releases/1.0.0.md)
- [Migrate from Linking 0.5 to 1.0](https://chipsi44.github.io/apizit-linking-examples/markdown/migrations/0.5-to-1.0.md)