http-api

Entrypoint — http-api

This file is consumed by Step 8 of the rewrite process. Apply when AUDIT_MANIFEST.projectType === "http-api".

Controller Convention

// src/modules/<domain>/<domain>.controller.ts
export class <Domain>Controller {
  constructor(private readonly service: <Domain>Service) {}

  async get<Domain>ById(req: Request, res: Response): Promise<void> {
    const { id } = validate(IdParamSchema, req.params);
    const result = await this.service.get<Domain>ById(id);
    res.status(200).json(ok(result));
  }
}

Rules:

1. Validate all inputs with validate() at the top of each method.
2. Use ok(), created(), or paginated() from src/lib/response.ts for all responses.
3. Wrap Express handlers with asyncHandler (see below) during route registration.
4. Controllers only receive service instances via constructor.

src/lib/async-handler.ts (Express only)

import type { Request, Response, NextFunction, RequestHandler } from 'express';
type AsyncFn = (req: Request, res: Response, next: NextFunction) => Promise<void>;
export function asyncHandler(fn: AsyncFn): RequestHandler {
  return (req, res, next) => void fn(req, res, next).catch(next);
}

Routes — src/routes/.routes.ts

Express:

import { Router } from 'express';
import { asyncHandler } from '../lib/async-handler.js';
import { <domain>Controller } from '../lib/container.js';

const router = Router();
router.get('/:id',  asyncHandler((req, res) => <domain>Controller.get<Domain>ById(req, res)));
router.post('/',    asyncHandler((req, res) => <domain>Controller.create<Domain>(req, res)));
export { router as <domain>Routes };

Fastify:

import type { FastifyPluginAsync } from 'fastify';
export const <domain>Routes: FastifyPluginAsync = async (fastify) => {
  fastify.get('/:id', handler);
  fastify.post('/', handler);
};

src/routes/index.ts

Register all domain routers under their base path:

// Express:
app.use('/api/v1/<domain>', <domain>Routes);
// Fastify:
app.register(<domain>Routes, { prefix: '/api/v1/<domain>' });