feat: swagger and cleanup

Author: msyavuz

nest-cli.json

@@ -1,8 +1,9 @@
 {
-  "$schema": "https://json.schemastore.org/nest-cli",
-  "collection": "@nestjs/schematics",
-  "sourceRoot": "src",
-  "compilerOptions": {
-    "deleteOutDir": true
-  }
+    "$schema": "https://json.schemastore.org/nest-cli",
+    "collection": "@nestjs/schematics",
+    "sourceRoot": "src",
+    "compilerOptions": {
+        "plugins": ["@nestjs/swagger"],
+        "deleteOutDir": true
+    }
 }

package-lock.json

@@ -27,6 +27,7 @@
         "@nestjs/core": "^10.0.0",
         "@nestjs/mapped-types": "*",
         "@nestjs/platform-express": "^10.0.0",
+        "@nestjs/swagger": "^7.3.0",
         "@nestjs/typeorm": "^10.0.1",
         "better-sqlite3": "^9.4.0",
         "pg": "^8.11.3",

package.json

@@ -1,15 +1,21 @@
 import { Controller, Get, Param, Query } from "@nestjs/common";
 import { ActorsService } from "./actors.service";
+import { ApiOkResponse, ApiTags } from "@nestjs/swagger";
+import { SearchQuery } from "./dto/search-query.dto";
+import { Actor } from "./entities/actor.entity";
 
+@ApiTags("actors")
 @Controller("actors")
 export class ActorsController {
     constructor(private readonly actorsService: ActorsService) {}
 
+    @ApiOkResponse({ type: Actor })
     @Get()
-    searchOne(@Query() query: { name?: string; description?: string }) {
+    searchOne(@Query() query: SearchQuery) {
         return this.actorsService.searchOne(query);
     }
 
+    @ApiOkResponse({ type: Actor })
     @Get(":id")
     findOne(@Param("id") id: string) {
         return this.actorsService.findOne(+id);

src/actors/actors.controller.ts

@@ -0,0 +1,4 @@
+export class SearchQuery {
+    name?: string;
+    description?: string;
+}

src/actors/dto/search-query.dto.ts

@@ -1,6 +1,9 @@
 import { Controller, Get, Param, Query } from "@nestjs/common";
 import { DentriesService } from "./dentries.service";
+import { ApiTags } from "@nestjs/swagger";
+import { SearchQuery } from "./dto/search-query.dto";
 
+@ApiTags("dentries")
 @Controller("dentries")
 export class DentriesController {
     constructor(private readonly dentriesService: DentriesService) {}
@@ -13,13 +16,7 @@ export class DentriesController {
     @Get()
     findOneByParams(
         @Query()
-        queryParams: {
-            title?: string;
-            text?: string;
-            actor?: number;
-            conversant?: number;
-            conversationid?: number;
-        },
+        queryParams: SearchQuery,
     ) {
         return this.dentriesService.searchOne(queryParams);
     }

src/dentries/dentries.controller.ts

@@ -0,0 +1,7 @@
+export class SearchQuery {
+    title?: string;
+    text?: string;
+    actor?: number;
+    conversant?: number;
+    conversationid?: number;
+}

src/dentries/dto/search-query.dto.ts

@@ -1,11 +1,20 @@
 import { NestFactory } from "@nestjs/core";
 import { AppModule } from "./app.module";
+import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
 
 const port = process.env.PORT || 3000;
 
 async function bootstrap() {
     const app = await NestFactory.create(AppModule);
     app.setGlobalPrefix("api/v1");
+    app.enableCors();
+
+    const config = new DocumentBuilder()
+        .setTitle("Disco API")
+        .setVersion("1.0")
+        .build();
+    const document = SwaggerModule.createDocument(app, config);
+    SwaggerModule.setup("docs", app, document);
 
     console.log(
         `Launching NestJS app on port ${port}, URL: http://0.0.0.0:${port}`,