#hclapi

hclapi is a backend engine distributed as a single binary. It turns HashiCorp Configuration Language (HCL) manifests into HTTP APIs, combining data access, business logic, validation, and API definitions in a single declarative configuration, with built-in OpenAPI generation.

Getting started#

Documentation#

Machine-readable documentation#

#How hclapi works

An endpoint consists of an HTTP route, optional request validation, and an ordered pipeline of steps.

1. A request is matched against an endpoint.

2. Path, query, header, and body data are validated when a request schema is defined.

3. Pipeline steps execute in order and write their outputs into the request context.

4. A respond step terminates the pipeline and writes the HTTP response.

See Request lifecycle for the complete execution model and Pipelines and steps for pipeline execution rules.

#What hclapi is for

hclapi is intended for small HTTP APIs where the API layer is mostly a thin interface over existing data.

It keeps endpoint definitions, queries, validation, and request processing close together in the manifest.

hclapi does not replace a general-purpose backend framework. Services that require substantial application logic, complex workflows, long-running state, identity and authentication, schema management, or multiple cooperating services may be better implemented in application code.

#Source

Source and issue tracker: