PackagesApi ServerOverview

@quatrain/api-server-express

📦 API Reference: Detailed TypeScript documentation, classes, interfaces, and methods are available in the TypeDoc API Reference for @quatrain/api-server ↗.

The @quatrain/api-server-express package provides the backend REST layer for Quatrain, exposing the underlying DataObjects and Backend engines through HTTP endpoints.

Features

  • Express Adapter: A lightweight wrapper around Express to bootstrap APIs instantly.
  • Auto-generated Endpoints: Pre-built CrudEndpoint and ListEndpoint handlers to instantly expose a Quatrain model (e.g. StudioProperty, StudioModel) as a complete REST API.
  • Middleware Support: Pluggable Express middlewares.

Getting Started

Refer to the HOWTO.md file for usage examples.

HOWTOHOWTO