Merge pull request #124 from mnfst/feature/api-doc

Display API Documentation (Swagger UI)
mnfst · Jul 2, 2024 · 9ad64d8 · 9ad64d8
2 parents fd24568 + 3598d57
commit 9ad64d8
Show file tree

Hide file tree

Showing 22 changed files with 2,567 additions and 15 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -34,6 +34,7 @@
     "metas",
     "mnfst",
     "nestjs",
+    "openapi",
     "typeorm",
     "uniqid"
   ],

diff --git a/packages/core/manifest/e2e/jest.setup.ts b/packages/core/manifest/e2e/jest.setup.ts
@@ -5,6 +5,8 @@ import { INestApplication } from '@nestjs/common'
 import supertest from 'supertest'
 import { load } from 'js-yaml'
 import fs from 'fs'
+import { SwaggerModule } from '@nestjs/swagger'
+import { OpenApiService } from '../src/open-api/services/open-api.service'
 
 let app: INestApplication
 
@@ -35,6 +37,10 @@ beforeAll(async () => {
   // Store request object in global scope to use in tests.
   global.request = supertest(app.getHttpServer())
 
+  // Set the SwaggerModule to serve the OpenAPI doc.
+  const openApiService = app.get(OpenApiService)
+  SwaggerModule.setup('api', app, openApiService.generateOpenApiObject())
+
   await app.init()
 })
 

diff --git a/packages/core/manifest/e2e/tests/open-api.e2e-spec.ts b/packages/core/manifest/e2e/tests/open-api.e2e-spec.ts
@@ -0,0 +1,8 @@
+describe('Open API (e2e)', () => {
+  it('GET /api', async () => {
+    const response = await global.request.get('/api')
+
+    expect(response.status).toBe(200)
+    expect(response.text).toContain('<html lang="en">')
+  })
+})
diff --git a/packages/core/manifest/package-lock.json b/packages/core/manifest/package-lock.json
diff --git a/packages/core/manifest/package.json b/packages/core/manifest/package.json
@@ -52,6 +52,7 @@
     "@nestjs/config": "^3.2.0",
     "@nestjs/core": "^10.3.3",
     "@nestjs/platform-express": "^10.3.3",
+    "@nestjs/swagger": "^7.3.1",
     "@nestjs/typeorm": "^10.0.2",
     "ajv": "^8.12.0",
     "better-sqlite3": "^9.6.0",

diff --git a/packages/core/manifest/src/app.module.ts b/packages/core/manifest/src/app.module.ts
@@ -16,6 +16,7 @@ import { ManifestModule } from './manifest/manifest.module'
 import { SeedModule } from './seed/seed.module'
 import { HealthModule } from './health/health.module'
 import { BetterSqlite3ConnectionOptions } from 'typeorm/driver/better-sqlite3/BetterSqlite3ConnectionOptions'
+import { OpenApiModule } from './open-api/open-api.module'
 
 @Module({
   imports: [
@@ -44,7 +45,8 @@ import { BetterSqlite3ConnectionOptions } from 'typeorm/driver/better-sqlite3/Be
     CrudModule,
     AuthModule,
     LoggerModule,
-    HealthModule
+    HealthModule,
+    OpenApiModule
   ]
 })
 export class AppModule {
@@ -57,8 +59,9 @@ export class AppModule {
   private async init() {
     const isSeed: boolean = process.argv[1].includes('seed')
     const isTest: boolean = process.env.NODE_ENV === 'test'
+    const isProduction: boolean = process.env.NODE_ENV === 'production'
 
-    if (!isSeed && !isTest) {
+    if (!isSeed && !isTest && !isProduction) {
       this.loggerService.initMessage()
     }
   }

diff --git a/packages/core/manifest/src/auth/auth.controller.ts b/packages/core/manifest/src/auth/auth.controller.ts
@@ -4,7 +4,9 @@ import { AuthenticableEntity } from '@mnfst/types'
 import { Request } from 'express'
 import { AuthService } from './auth.service'
 import { SignupAuthenticableEntityDto } from './dtos/signup-authenticable-entity.dto'
+import { ApiTags } from '@nestjs/swagger'
 
+@ApiTags('Auth')
 @Controller('auth')
 export class AuthController {
   constructor(private readonly authService: AuthService) {}

diff --git a/packages/core/manifest/src/auth/dtos/signup-authenticable-entity.dto.ts b/packages/core/manifest/src/auth/dtos/signup-authenticable-entity.dto.ts
@@ -1,10 +1,19 @@
+import { ApiProperty } from '@nestjs/swagger'
 import { IsEmail, IsNotEmpty } from 'class-validator'
 
 export class SignupAuthenticableEntityDto {
+  @ApiProperty({
+    description: 'The email of the user',
+    example: 'admin@manifest.build'
+  })
   @IsNotEmpty()
   @IsEmail()
   public email: string
 
+  @ApiProperty({
+    description: 'The password of the user',
+    example: 'admin'
+  })
   @IsNotEmpty()
   public password: string
 }
diff --git a/packages/core/manifest/src/config/paths.ts b/packages/core/manifest/src/config/paths.ts
@@ -1,7 +1,8 @@
-export default (): { paths: { admin: string } } => {
+export default (): { paths: { admin: string; database: string } } => {
   return {
     paths: {
-      admin: `${process.cwd()}/node_modules/@mnfst/admin/dist`
+      admin: `${process.cwd()}/node_modules/@mnfst/admin/dist`,
+      database: `${process.cwd()}/manifest/backend.yml`
     }
   }
 }
diff --git a/packages/core/manifest/src/constants.ts b/packages/core/manifest/src/constants.ts
@@ -1,7 +1,3 @@
-// Manifest.
-export const MANIFEST_FOLDER_NAME = 'manifest'
-export const MANIFEST_FILE_NAME = 'backend.yml'
-
 // Default values.
 export const DEFAULT_PORT = 1111
 export const DEFAULT_RESULTS_PER_PAGE = 20

diff --git a/packages/core/manifest/src/logger/logger.service.ts b/packages/core/manifest/src/logger/logger.service.ts
@@ -17,13 +17,21 @@ export class LoggerService {
 
     console.log()
 
+    console.log(chalk.blue('Manifest backend successfully started! '))
+    console.log()
+
     console.log(
       chalk.blue(
-        '🎉 Manifest successfully started! See your admin panel: ',
+        '🖥️  Admin Panel: ',
         chalk.underline.blue(`http://localhost:${port}`)
       )
     )
-
+    console.log(
+      chalk.blue(
+        '📚 API Doc: ',
+        chalk.underline.blue(`http://localhost:${port}/api`)
+      )
+    )
     console.log()
   }
 }