feat: disable document page

libs/api-gateway/api-gateway.module.ts

@@ -11,7 +11,7 @@ export class ApiGatewayModule {
         return {
             global: true,
             module: ApiGatewayModule,
-            imports: [ThrottlerModule.forRoot(option.throttler), RestfulModule],
+            imports: [ThrottlerModule.forRoot(option.throttler), RestfulModule.forRoot(option.restful)],
             controllers: [],
             providers: [
                 {

libs/api-gateway/restful/restful.module.ts

@@ -1,4 +1,4 @@
-import { Module } from '@nestjs/common';
+import { DynamicModule, Module } from '@nestjs/common';
 import { ProxyController } from './controllers/proxy.controller';
 import { HttpModule } from '@nestjs/axios';
 import { ProxyService } from './services/proxy.service';
@@ -7,10 +7,17 @@ import { RequestService } from './services/request.service';
 import { DocumentController } from './controllers/document.controller';
 import { UpdateApiDocumentTask } from './tasks/update-api-document.task';
 import { WsRequestService } from './services/ws-request.service';
+import { RestfulOption } from './types/restful-option.type';
 
-@Module({
-    imports: [HttpModule],
-    controllers: [DocumentController, ProxyController],
-    providers: [ProxyService, OpenApiService, RequestService, WsRequestService, UpdateApiDocumentTask]
-})
-export class RestfulModule {}
+@Module({})
+export class RestfulModule {
+    static forRoot(option: RestfulOption): DynamicModule {
+        console.log(option.isEnableDocument);
+        return {
+            module: RestfulModule,
+            imports: [HttpModule],
+            controllers: [...(option.isEnableDocument ? [DocumentController] : []), ProxyController],
+            providers: [ProxyService, OpenApiService, RequestService, WsRequestService, UpdateApiDocumentTask]
+        };
+    }
+}

libs/api-gateway/restful/types/restful-option.type.ts

@@ -0,0 +1,3 @@
+export type RestfulOption = {
+    isEnableDocument: boolean;
+};

libs/api-gateway/types/api-gateway-option.type.ts

@@ -1,10 +1,12 @@
 import { ThrottlerOption } from '../throttlers/types/throttler-option.type';
 import { ApiServiceDetail } from '../restful/types/api-service.type';
+import { RestfulOption } from '../restful/types/restful-option.type';
 
 export type ApiGatewayOption = {
     apiServices: ApiServiceDetail[];
     excludeHeaders: string[];
     openApiSecurityKeys: string[];
     throttler: ThrottlerOption;
+    restful: RestfulOption;
     libraryPath?: string;
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hodfords/nestjs-api-gateway",
-  "version": "10.0.11",
+  "version": "10.1.0",
   "description": "The API Gateway houses the source code and documentation for the API Gateway - a powerful and versatile solution for managing and deploying APIs within a distributed and microservices-oriented architecture.",
   "author": "",
   "private": false,

src/app.module.ts

@@ -20,7 +20,8 @@ import { env } from '~config/env.config';
                 globalRateLimit: 60,
                 isEnable: true,
                 globalRateLimitTTL: 60
-            }
+            },
+            restful: { isEnableDocument: true }
         })
     ],
     controllers: [AppController],