Skip to content

Latest commit

 

History

History
title API Surface
description The REST interface the server exposes to the world
audience
developer
architect

Wiki Home

API Surface

Everything the Express server exposes over HTTP — conventions, query features, writes, limits, and errors.

Page One-liner
REST Conventions URL shape, collections vs. singular resources, json-server compatibility
Querying & Filtering Equality, dot paths, operator suffixes, full-text q
Sorting & Pagination _sort/_order, _page/_limit, ranges, Link header
CRUD & Validation Write semantics, shape validation, per-file locking
Rate Limiting The global and per-API limiters
Error Responses Every error shape and what triggers it
Service Routes /health, /frontend, /resetit, /create, /generate, /test, legacy /

The data these endpoints serve is described in Endpoint Data.