add description

Author: vellengs

README.MD

@@ -1,2 +1,33 @@
 
-# Swagger for Nest
+# Swagger for Nest
+
+### Quick start
+
+- install
+```bash
+npm install nest-swagger
+```
+
+- add swagger.config.json
+``` bash
+    {
+        "swagger": {
+            "outputDirectory": "./dist",
+            "entryFile": "./src/main.ts",
+            "name": "your app name",
+            "description": "description",
+            "license": "MIT",
+            "produces": ["application/json"],
+            "version": "0.0.1"
+        }
+    }
+```
+- add npm script
+```
+    "swagger": "swaggerGen -c ./swagger.config.json",
+```
+- run npm script 
+```
+    npm run swagger
+```
+you can find the output generated `swagger.json` and `swagger.yaml`

test/nestjs/app.controller.ts

@@ -39,6 +39,11 @@ class Address {
   houseNumber: string;
 }
 
+class KeyValueDto {
+  label: string;
+  value: string;
+}
+
 interface Query {
   size: number;
   index: number;
@@ -74,6 +79,14 @@ export class AppController {
     return null;
   }
 
+  @Get('search')
+  async search(
+    @Query('keyword') keyword?: string,
+    @Query('value') value?: string
+  ): Promise<KeyValueDto[]> {
+    return null;
+  }
+
   @Get(':id')
   async findOne(@Param('id') id: string): Promise<User> {
     return null;