doc

JmpAPI Configuration

JmpAPI builds a JSON-over-HTTP API from one or more YAML files. Each file declares URL endpoints that map HTTP methods to SQL queries, login flows, file serving, websockets, HTTP proxies, external programs, and conditional pipelines.

A minimal config:

jmpapi: 1.2.0

info:
  title: Example
  version: 1.0.0

endpoints:
  /hello:
    get:
      sql: SELECT 'world' AS greeting
      return: dict

Run with jmpapi config.yaml.

Reference

• configuration.md — top-level keys, includes, options
• endpoints.md — paths, methods, nesting, common keys
• handlers.md — handler types and their config
• exec.md — run an external program as a pipeline step
• conditions.md — if/then/else control flow
• args.md — argument validation, types, inheritance
• sql.md — SQL queries, interpolation, return types, fields
• binary.md — binary bodies, multipart uploads, BLOBs
• access-control.md — allow/deny, groups, sessions
• auth.md — OAuth2 setup and password-based login
• timeseries.md — periodic SQL data and websocket streams

Conventions

• {name} in a URL is a path parameter, available as {args.name}.
• {x.y} inside a string references a request value: bound as a parameter in SQL, interpolated elsewhere (see sql.md). A missing ref is an error; {~x.y} resolves null when missing.
• Keys starting with / are nested child paths.
• HTTP methods are lower-case (get, put, post, delete); combine with | (e.g. get|put); use any to match all methods.

Example configs

See api/jmpapi-example.yaml, api/jmpapi-auth.yaml, and api/jmpapi-files.yaml in this repo for working examples.