nestjs-swagger-koa
v1.1.0
Published
NestJS module for generating Swagger documentation for Koa applications
Downloads
66
Maintainers
Readme
About
This library is a NestJS module for generating Swagger documentation for Koa applications. Was created due this issue in the official NestJS Swagger module. Also, this library is based on the official NestJS Swagger module and NestJS Koa adapter.
Installation
$ npm install --save nestjs-swagger-koa @nestjs/swagger nest-koa-adapter
$ yarn add nestjs-swagger-koa @nestjs/swagger nest-koa-adapter
$ pnpm add nestjs-swagger-koa @nestjs/swagger nest-koa-adapter
Usage
Usage was not changed from the official NestJS Swagger module. You can find the usage in the official
documentation here.
All you need to do is to replace the @nestjs/swagger
module with nestjs-swagger-koa
and import the NestKoaAdapter
from nest-koa-adapter
. Here is an example:
import { NestFactory } from '@nestjs/core';
import { DocumentBuilder } from '@nestjs/swagger';
import { AppModule } from './app.module';
import { KoaSwaggerModule } from 'nestjs-swagger-koa';
async function bootstrap() {
const app = await NestFactory.create(AppModule);
const config = new DocumentBuilder()
.setTitle('Cats example')
.setDescription('The cats API description')
.setVersion('1.0')
.addTag('cats')
.build();
const document = KoaSwaggerModule.createDocument(app, config);
KoaSwaggerModule.setup('api', app, document);
await app.listen(3000);
}
bootstrap();
Stay in touch
- Author - Alexey Filippov
- Twitter - @SocketSomeone