@e22m4u/ts-rest-router-openapi v0.0.1

@e22m4u/ts-rest-router-openapi

Генератор OpenAPI документации для REST-маршрутизатора

Установка

npm install @e22m4u/ts-rest-router-openapi

Поддержка декораторов

Для включения поддержки декораторов, добавьте указанные ниже опции в файл tsconfig.json вашего проекта.

{
  "emitDecoratorMetadata": true,
  "experimentalDecorators": true
}

Использование

Генерация OpenAPI документа:

import {RestRouter} from '@e22m4u/ts-rest-router';
import {RestRouterOpenAPI} from '@e22m4u/ts-rest-router-openapi';

// создание маршрутизатора и регистрация контроллеров
const router = new RestRouter();
// router.registerController(...);

// создание сервиса генерации OpenAPI документа,
// и иньекция маршрутизатора в данный сервис
const routerOpenAPI = new RestRouterOpenAPI();
routerOpenAPI.setService(RestRouter, router);

// генерация документа
const openAPIDoc = routerOpenAPI.genOpenAPIDocument({
  info: {
    title: 'My Amazing Api',
    version: '0.0.1',
  },
});

Тесты

npm run test

Лицензия

MIT