How validraganescu/openapi-router works
Main Components
a) Core Router System:
• Router Singleton (from src/router/router.ts)
• To Request Handler (src/router/request-handler.ts)
• Connection to Lambda Router integration (src/router/lambda-router.ts)
b) Metadata Management System:
• Connections to decorators (@DocMetadata and @Route)
• Relationship with model metadata, method metadata, and route metadata
c) Documentation Generation System:
• API Documentation Generator component
• Connections to OpenAPI 3.0 spec output
• To metadata storage system
d) Validation System:
• Validator component
• Connections to request/response validation flow
• To metadata system for schema validation
e) Middleware System:
• Both global and route-specific middleware handlers
• Before/after middleware flow
• To the main request processing pipeline
Component Relationships and Data Flow
Request → Global Before Middleware → Route Before Middleware → Handler → Route After Middleware → Global After Middleware → Response
Specific Implementation Details
• Request<T>
• Response<T>
• Router
• MetadataStorage
• ApiDocGenerator
• Validator
• MiddlewareHandler
Important Architectural Patterns to Highlight
• Decorator Pattern: Show how @DocMetadata and @Route decorators interact
• Singleton Pattern: Highlight Router instance
• Middleware Chain: Demonstrate the middleware execution flow
• Metadata Repository: Show centralized metadata storage
External Integration Points
• Lambda integration point
• OpenAPI 3.0 documentation output
• HTTP request/response interfaces