[Core]: Provide auth in document

Author: dnphu

src/api/core/document.ts

@@ -1,21 +1,36 @@
-import { OPEN_API_VERSION } from 'src/constants';
+import { OPEN_API_VERSION, SECURITY_KEY } from 'src/constants';
 import { Validate } from 'src/utils/validate';
 import {
+  ApiKeyDoc,
+  BearerAuthDoc,
   ExternalDoc,
   InfoDoc,
+  OAth2Doc,
   ServerDoc,
   SwaggerDoc,
 } from './interfaces/document.interface';
 
 export class DocumentBuilder {
-  private document: SwaggerDoc = { openapi: OPEN_API_VERSION };
+  private document: SwaggerDoc = {
+    openapi: OPEN_API_VERSION,
+    components: {
+      schemas: {},
+      securitySchemes: {},
+      responses: {},
+    },
+    paths: {},
+  };
 
   public setExternalDocs(externalDoc: ExternalDoc): DocumentBuilder {
     this.document.externalDocs = externalDoc;
     return this;
   }
 
   public setServers(...servers: ServerDoc[]) {
+    servers.forEach((server: ServerDoc) => {
+      Validate.assertString(server.url, 'url must be declared in server');
+    });
+
     this.document.servers = servers;
     return this;
   }
@@ -33,6 +48,30 @@ export class DocumentBuilder {
     return this;
   }
 
+  public setBearerAuth() {
+    this.document.components.securitySchemes[SECURITY_KEY.BEARER_KEY] = {
+      type: 'http',
+      bearerFormat: 'JWT',
+      scheme: 'bearer',
+    } as BearerAuthDoc;
+
+    return DocumentBuilder;
+  }
+
+  public setApiKey() {
+    this.document.components.securitySchemes[SECURITY_KEY.API_KEY] = {
+      type: 'apiKey',
+      name: 'api_key',
+      in: 'header',
+    } as ApiKeyDoc;
+    return DocumentBuilder;
+  }
+
+  public setOauth2(key: string, oauth2Flow: OAth2Doc) {
+    this.document.components.securitySchemes[key] = oauth2Flow;
+    return DocumentBuilder;
+  }
+
   public build(): SwaggerDoc {
     return this.document;
   }

src/api/core/element.ts src/api/core/factory.tssrc/api/core/element.ts renamed to src/api/core/factory.ts

@@ -58,15 +58,15 @@ export interface ExternalDoc {
 export interface ComponentDoc {
   schemas: Record<string, SchemaDoc> | RefDoc;
   securitySchemes:
-    | Record<string, SecurityDoc | BearerAuthDoc | ApiKeyDoc>
+    | Record<string, SecurityDoc | BearerAuthDoc | ApiKeyDoc | OAth2Doc>
     | RefDoc;
   responses: Record<string, ResponseDoc> | RefDoc;
-  parameters: Record<string, ParameterDoc> | RefDoc;
-  examples: any | RefDoc;
-  requestBodies: any | RefDoc;
-  headers: any | RefDoc;
-  links: any | RefDoc;
-  callbacks: any | RefDoc;
+  parameters?: Record<string, ParameterDoc> | RefDoc;
+  examples?: any | RefDoc;
+  requestBodies?: any | RefDoc;
+  headers?: any | RefDoc;
+  links?: any | RefDoc;
+  callbacks?: any | RefDoc;
 }
 
 export interface RefDoc {
@@ -130,6 +130,11 @@ export type ApiKeyDoc = {
   in: 'header';
 };
 
+export type OAth2Doc = {
+  type: 'oauth2';
+  flows: OAuthFlows;
+};
+
 export type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch';
 
 export interface PathDoc {

src/api/core/interfaces/document.interface.ts

@@ -1 +1,5 @@
 export const OPEN_API_VERSION = '3.0.1';
+export enum SECURITY_KEY {
+  BEARER_KEY = 'Bearer',
+  API_KEY = 'ApiKey',
+}