feat: add meta description parameter

Author: didikmulyadi

src/core/constant.ts

@@ -4,11 +4,13 @@ import { ApiDocPlatformType } from './web'
 const DEFAULT_API_DOC_PLATFORM: ApiDocPlatformType = 'stoplight'
 const DEFAULT_PATH = '/docs'
 const DEFAULT_TITLE = 'API Docs'
+const DEFAULT_META_DESCRIPTION = 'API Documentation'
 const DEFAULT_STOPLIGHT_LAYOUT: IStoplight['layout'] = 'sidebar'
 
 export {
   DEFAULT_PATH,
   DEFAULT_API_DOC_PLATFORM,
   DEFAULT_TITLE,
   DEFAULT_STOPLIGHT_LAYOUT,
+  DEFAULT_META_DESCRIPTION,
 }

src/framework/base.ts

@@ -3,13 +3,15 @@ import {
   DEFAULT_STOPLIGHT_LAYOUT,
   DEFAULT_TITLE,
   DEFAULT_API_DOC_PLATFORM,
+  DEFAULT_META_DESCRIPTION,
 } from '@/core/constant'
 import { NodeJSApiDocHandler } from '@/core/server'
 import { IStoplight } from '@/core/type'
 import { ApiDocPlatformType } from '@/core/web'
 
 type Config = {
   title: string
+  metaDescription: string
   apiDocPlatfomDefault: ApiDocPlatformType
   apiDocPlatfomLayout: string
   path: string
@@ -22,6 +24,12 @@ type BaseConfigOnConstructor = {
    */
   title?: string
 
+  /**
+   * The page meta description
+   * @default "API Documentation"
+   */
+  metaDescription?: string
+
   /**
    * the default of doc path, the value should have / in prefix
    * @default "/docs"
@@ -104,7 +112,11 @@ class JSApiDocBaseFramework {
    * 
    */
   constructor(app: any, document: object, config: ConfigOnConstructor = {}) {
-    const { customPath = DEFAULT_PATH, title = DEFAULT_TITLE } = config
+    const {
+      customPath = DEFAULT_PATH,
+      title = DEFAULT_TITLE,
+      metaDescription = DEFAULT_META_DESCRIPTION,
+    } = config
 
     let layout = ''
     let apiDocPlatformType: ApiDocPlatformType =
@@ -126,6 +138,7 @@ class JSApiDocBaseFramework {
     this.document = document
     this.config = {
       title,
+      metaDescription,
       apiDocPlatfomDefault: apiDocPlatformType,
       path: customPath,
       apiDocPlatfomLayout: layout,