Open API
The @inversifyjs/http-open-api package provides comprehensive OpenAPI 3.1 integration for InversifyJS HTTP applications. This powerful library enables you to automatically generate OpenAPI specifications and interactive Swagger UI documentation directly from your TypeScript controllers and schemas.
Features
- Decorator-based API Documentation: Use TypeScript decorators to annotate your controllers, methods, and data models with OpenAPI metadata
- Automatic Schema Generation: Generate OpenAPI schemas from TypeScript classes with property-level validation and documentation
- Swagger UI Integration: Built-in Swagger UI provider that automatically serves interactive API documentation
- Type-safe Schema References: Reference schema classes in a type-safe manner
- Comprehensive OpenAPI Support: Full support for OpenAPI 3.1 specification including operations, request/response bodies, parameters, security, and servers
- Framework Agnostic: Works with Express, Fastify, Hono, and other supported HTTP frameworks
Getting Started
To learn more about using the OpenAPI integration, including detailed examples and API reference, visit the comprehensive documentation:
The documentation includes step-by-step guides, decorator references, and complete examples showing how to build fully documented APIs with automatic Swagger UI generation.