Skip to content

API Reference

This section documents the public API surface of Vix.

It focuses on:

  • Core HTTP primitives
  • Routing
  • Request & Response
  • JSON layer
  • WebSocket
  • Configuration
  • Runtime behavior

The goal of this section is precision.

If the Guide shows how to use Vix, the API section shows what exactly exists.


Structure

  • App
  • Request
  • Response
  • Routing methods
  • JSON helpers
  • WebSocket server
  • Config loader

Each page in this section describes:

  • Available methods
  • Signatures
  • Minimal usage examples
  • Behavioral notes

Philosophy

The Vix API follows strict principles:

  • Explicit over magic
  • Minimal abstraction layers
  • Deterministic behavior
  • No hidden global state
  • No runtime reflection

Everything that happens should be visible in code.


Continue with the next API component page.