Routes and tags

Routes and OpenAPI tags are centralized in configuration classes, avoiding duplicated strings across controllers.

RouterConfigBase

export abstract class RouterConfigBase {
  protected constructor(
    private readonly _tag: string,
    private readonly _group: string,
  ) {}

  get group() {
    return this._group;
  }

  get tag() {
    return this._tag;
  }
}

• group — route prefix passed to NestJS @Controller() (e.g. /person).
• tag — grouping in Swagger/Scalar (e.g. Person).

Person resource configuration

class PersonRouterConfig extends RouterConfigBase {
  constructor() {
    super('Person', '/person');
  }
}

export const PERSON_ROUTER_CONFIG = new PersonRouterConfig();

Usage in controllers

All Person controllers share the same configuration:

@Controller(PERSON_ROUTER_CONFIG)
export class CreatePersonController implements IController<...> { ... }

@Controller(PERSON_ROUTER_CONFIG)
export class ReadManyPersonController implements IController<...> { ... }

This groups endpoints under /person and the Person tag in interactive documentation.

Resulting endpoints

Creating configuration for a new resource

1. Create src/host/controllers/<resource>/router.config.ts.
2. Extend RouterConfigBase with the desired tag and prefix.
3. Export a constant instance (e.g. PRODUCT_ROUTER_CONFIG).
4. Use @Controller(PRODUCT_ROUTER_CONFIG) on all resource controllers.