Improve the Swagger Documentation

codelittinc · Nov 3, 2022 · 17e171d · 17e171d
1 parent 6dba9e5
commit 17e171d
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 8 deletions.
diff --git a/package.json b/package.json
@@ -1,10 +1,10 @@
 {
   "name": "calendar-api",
-  "version": "0.0.1",
-  "description": "",
-  "author": "",
+  "version": "1.0.0",
+  "description": "Our calendar API should be used as a tool to test integration capabilities with an API.",
+  "author": "https://github.com/Wellington-gc",
   "private": true,
-  "license": "UNLICENSED",
+  "license": "MIT",
   "scripts": {
     "config": "cp .env.example .env",
     "docker:start:dev": "docker-compose up -d && docker exec --user node -it calendar-api-app bash",
@@ -86,4 +86,4 @@
     "coverageDirectory": "../coverage",
     "testEnvironment": "node"
   }
-}
+}
diff --git a/src/main.ts b/src/main.ts
@@ -15,9 +15,9 @@ async function bootstrap() {
 
   const swaggerConfig = new DocumentBuilder()
     .setTitle('Calendar API Swagger Documentation - Codelitt')
-    .setDescription(
-      'This is an API built to be used when creating calendars reminders by [Codelitt](https://www.codelitt.com/).',
-    )
+    .setContact('Codelitt', 'https://www.codelitt.com/', '[email protected]')
+    .setExternalDoc('API documentation', 'https://github.com/codelittinc/calendar-api#readme')
+    .setDescription('This is an API built to create calendars reminders.')
     .setVersion('v1')
     .build();
 

diff --git a/src/reminders/reminders.controller.ts b/src/reminders/reminders.controller.ts
@@ -15,6 +15,23 @@ export class RemindersController {
   @ApiResponse({
     status: 201,
     description: 'The reminder has been successfully created',
+    schema: {
+      example: {
+        title: 'Title Example',
+        description: 'Description example',
+        date: '2022-11-03T15:14:21.005Z',
+        color: '#FFFFFF',
+        token: {
+          id: '21681ba4-7556-4358-9500-e4afe1ce6141',
+          name: 'John Doe',
+          createdAt: '2022-11-02T15:12:13.242Z',
+          updatedAt: '2022-11-02T15:12:13.242Z',
+        },
+        id: '0493ad93-1290-41ea-818e-c7a371c828df',
+        createdAt: '2022-11-03T15:14:36.265Z',
+        updatedAt: '2022-11-03T15:14:36.265Z',
+      },
+    },
   })
   @ApiResponse({
     status: 400,
@@ -29,6 +46,16 @@ export class RemindersController {
   @ApiResponse({
     status: 200,
     description: 'Returns an array with the days that have created reminders',
+    schema: {
+      example: [
+        {
+          date: '2022-11-02T00:00:00.000Z',
+        },
+        {
+          date: '2022-11-03T00:00:00.000Z',
+        },
+      ],
+    },
   })
   @ApiResponse({
     status: 400,
@@ -47,6 +74,28 @@ export class RemindersController {
   @ApiResponse({
     status: 200,
     description: 'Returns a list of reminders for the selected date',
+    schema: {
+      example: [
+        {
+          id: '0493ad93-1290-41ea-818e-c7a371c828df',
+          title: 'Title Example',
+          description: 'Description example',
+          date: '2022-11-03T15:14:21.005Z',
+          color: '#FFFFFF',
+          createdAt: '2022-11-03T15:14:36.265Z',
+          updatedAt: '2022-11-03T15:14:36.265Z',
+        },
+        {
+          id: 'f2c1f472-0743-450c-a928-71810066d7ba',
+          title: 'Title Example',
+          description: 'Description example',
+          date: '2022-11-03T15:17:13.222Z',
+          color: '#FFFFFF',
+          createdAt: '2022-11-03T15:17:38.778Z',
+          updatedAt: '2022-11-03T15:17:38.778Z',
+        },
+      ],
+    },
   })
   @ApiResponse({
     status: 400,
@@ -62,6 +111,17 @@ export class RemindersController {
   @ApiResponse({
     status: 200,
     description: 'Returns a single reminder',
+    schema: {
+      example: {
+        id: '417b9cb6-6953-4cb5-b42e-6b6c8b209fe5',
+        title: 'Title Example',
+        description: 'Description example',
+        date: '2022-11-02T20:11:45.639Z',
+        color: '#FFFFFF',
+        createdAt: '2022-11-02T19:29:25.186Z',
+        updatedAt: '2022-11-02T20:12:26.845Z',
+      },
+    },
   })
   @ApiResponse({
     status: 400,

diff --git a/src/tokens/tokens.controller.ts b/src/tokens/tokens.controller.ts
@@ -13,6 +13,14 @@ export class TokensController {
   @ApiResponse({
     status: 201,
     description: 'The token has been created successfully',
+    schema: {
+      example: {
+        id: '21681ba4-7556-4358-9500-e4afe1ce6141',
+        name: 'John Doe',
+        createdAt: '2022-11-02T15:12:13.242Z',
+        updatedAt: '2022-11-02T15:12:13.242Z',
+      },
+    },
   })
   @ApiResponse({
     status: 400,
@@ -27,6 +35,14 @@ export class TokensController {
   @ApiResponse({
     status: 200,
     description: 'Returns a single token',
+    schema: {
+      example: {
+        id: '21681ba4-7556-4358-9500-e4afe1ce6141',
+        name: 'John Doe',
+        createdAt: '2022-11-02T15:12:13.242Z',
+        updatedAt: '2022-11-02T15:12:13.242Z',
+      },
+    },
   })
   @ApiResponse({
     status: 400,