swager documentation

src/main.ts

@@ -6,11 +6,11 @@ async function bootstrap() {
     const app = await NestFactory.create(AppModule);
 
     const options = new DocumentBuilder()
-    .setTitle('Store API')
+        .setTitle('Store API')
-    .setDescription('API работает по принципу LocalStorage в браузере.')
+        .setDescription('API работает по принципу LocalStorage в браузере.')
-    .setVersion('1.0.0')
+        .setVersion('1.0.0')
-    .addTag('store')
+        .addTag('store')
-    .build();
+        .build();
 
     const document = SwaggerModule.createDocument(app, options);
     SwaggerModule.setup('api', app, document);

src/store/store.controller.ts

@@ -1,6 +1,7 @@
 import { Controller, Get, Post, Body, Param } from '@nestjs/common';
 import {StoreService} from './store.service';
-import {Store, StoreParams} from './store.schema';
+import {Store, StoreResponse, StoreRequest} from './store.schema';
+import {ApiResponse} from '@nestjs/swagger';
 
 @Controller('store')
 export class StoreController {
@@ -9,17 +10,32 @@ export class StoreController {
     ) {}
 
     @Get()
+    @ApiResponse({
+        status: 200, 
+        description: 'Список всех пар ключ-значение', 
+        type: [StoreResponse],
+    })
     async findAll(): Promise<Store[]> {
         return this.storeService.findAll();
     }
 
     @Get(':key?')
+    @ApiResponse({
+        status: 200,
+        description: 'Возвращает пару ключ-значение по ключу',
+        type: StoreResponse,
+    })
     async findOne(@Param() {key}: {key: string}): Promise<Store> {
         return this.storeService.findOne(key);
     }
 
     @Post()
-    async create(@Body() createStoreClass: StoreParams): Promise<Store> {
+    @ApiResponse({
+        status: 200,
+        description: 'Создает новую пару ключ-значение или заменяет существующую по ключу',
+        type: StoreResponse,
+    })
+    async create(@Body() createStoreClass: StoreRequest): Promise<Store> {
         return this.storeService.create(createStoreClass);
     }
 }

src/store/store.schema.ts

@@ -1,10 +1,27 @@
 import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
 import { Document } from 'mongoose';
+import {ApiProperty} from '@nestjs/swagger';
 
-export class StoreParams {
+export class StoreRequest {
+    @ApiProperty()
     key: string;
+
+    @ApiProperty()
     value: any;
 }
+export class StoreResponse {
+    @ApiProperty()
+    key: string;
+
+    @ApiProperty()
+    value: any;
+
+    @ApiProperty()
+    _id: string;
+
+    @ApiProperty()
+    __v: number;
+}
 
 @Schema()
 export class Store extends Document {

src/store/store.service.ts

@@ -1,7 +1,7 @@
 import {Model} from 'mongoose';
 import {Injectable} from '@nestjs/common';
 import {InjectModel} from '@nestjs/mongoose';
-import {Store, StoreParams} from './store.schema';
+import {Store, StoreRequest} from './store.schema';
 
 
 @Injectable()
@@ -12,7 +12,7 @@ export class StoreService {
         return this.storeModel.find().exec();
     }
 
-    async create(store: StoreParams): Promise<Store> {
+    async create(store: StoreRequest): Promise<Store> {
         const searchStore = await this.findOne(store.key);
         
         if (searchStore) {