@breadstone/archipel-platform-openapi

Multi-tenant Swagger/OpenAPI documentation system with feature-scoped discovery, customizable themes, and automatic endpoint registration.

Features

• Feature-scoped documents — @SwaggerFeature decorator for per-module Swagger docs
• Per-endpoint metadata — @Api decorator for OpenAPI annotations
• Multi-document generation — SwaggerMultiDocumentService for separate feature APIs
• Customizable themes — SwaggerTheme with CSS/JS asset caching
• Auto-discovery — SwaggerFeatureDiscovery scans modules automatically
• Spec export — Export OpenAPI spec as JSON/YAML for CI contract checks

⚠️ Environment Variables

| Variable | Required | Default | Description | | ----------------------- | -------- | ------- | ------------------------ | | APP_VERSION | yes | - | Version shown in Swagger | | SWAGGER_CONTACT_NAME | yes | - | Contact name | | SWAGGER_CONTACT_URL | yes | - | Contact URL | | SWAGGER_CONTACT_EMAIL | yes | - | Contact email |

Quick Start

import { SwaggerFeature, Api } from '@breadstone/archipel-platform-openapi';
import { SwaggerMultiDocumentService, SwaggerTheme } from '@breadstone/archipel-platform-openapi';

Peer Dependencies

| Package | Required | Notes | | ----------------- | -------- | ----------------------- | | @nestjs/common | Yes | NestJS core | | @nestjs/swagger | Yes | Swagger/OpenAPI support |

Documentation

📖 Package Docs: .docs/packages/platform-openapi/index.md

Development

# Build
yarn nx build platform-openapi

# Test
yarn nx test platform-openapi

# Lint
yarn nx lint platform-openapi