Http Server

HTTP Server Protocol

Route-registration metadata, middleware declaration and the server-side lifecycle/status vocabulary for HTTP server implementations (Express, Fastify, Hono, etc.)

Architecture alignment:

Kubernetes: Service and Ingress resources
AWS: API Gateway configuration
Spring Boot: Application properties

Source: packages/spec/src/system/http-server.zod.ts

TypeScript Usage

import { MiddlewareConfigSchema, MiddlewareType, RouteHandlerMetadataSchema } from '@objectstack/spec/system';
import type { MiddlewareConfig, MiddlewareType, RouteHandlerMetadata } from '@objectstack/spec/system';

// Validate data
const result = MiddlewareConfigSchema.parse(data);

MiddlewareConfig

Properties

Property	Type	Required	Description
name	`string`	✅	Middleware name (snake_case)
type	`Enum<'authentication' \| 'authorization' \| 'logging' \| 'validation' \| 'transformation' \| 'error' \| 'custom'>`	✅	Middleware type
enabled	`boolean`	optional (default: `true`)	Whether middleware is enabled
order	`integer`	optional (default: `100`)	Execution order priority
config	`Record<string, any>`	optional	Middleware configuration object
paths	`{ include?: string[]; exclude?: string[] }`	optional	Path filtering

Nested Shape: `MiddlewareConfig.paths`

Property	Type	Required	Description
include	`string[]`	optional	Include path patterns (glob)
exclude	`string[]`	optional	Exclude path patterns (glob)

MiddlewareType

Allowed Values

authentication
authorization
logging
validation
transformation
error
custom

RouteHandlerMetadata

Properties

Property	Type	Required	Description
method	`Enum<'GET' \| 'POST' \| 'PUT' \| 'DELETE' \| 'PATCH' \| 'HEAD' \| 'OPTIONS'>`	✅	HTTP method
path	`string`	✅	URL path pattern
handler	`string`	✅	Handler identifier or name
metadata	`{ summary?: string; description?: string; tags?: string[]; operationId?: string }`	optional
security	`{ authRequired: boolean; permissions?: string[]; rateLimit?: string }`	optional

Nested Shape: `RouteHandlerMetadata.metadata`

Property	Type	Required	Description
summary	`string`	optional	Route summary for documentation
description	`string`	optional	Route description
tags	`string[]`	optional	Tags for grouping
operationId	`string`	optional	Unique operation identifier

Nested Shape: `RouteHandlerMetadata.security`

Property	Type	Required	Description
authRequired	`boolean`	optional (default: `true`)	Require authentication
permissions	`string[]`	optional	Required permissions
rateLimit	`string`	optional	Rate limit policy override

Http Server

On this page