@inversifyjs/express-open-api

InversifyJS HTTP Express OpenAPI integration package.

This package provides OpenAPI/Swagger UI integration for Express-based InversifyJS HTTP applications.

Installation

npm install @inversifyjs/express-open-api @inversifyjs/http-open-api express

Usage

import { Container } from 'inversify';
import { SwaggerUiExpressProvider } from '@inversifyjs/express-open-api';

const container = new Container();

const swaggerUiProvider = new SwaggerUiExpressProvider({
  api: {
    path: '/docs',
    openApiObject: {
      openapi: '3.1.0',
      info: {
        title: 'My API',
        version: '1.0.0',
      },
      paths: {},
    },
  },
  ui: {
    title: 'My API Documentation',
  },
});

swaggerUiProvider.provide(container);

Requirements

• @inversifyjs/http-open-api (peer dependency)
• express (peer dependency)
• inversify (peer dependency)