Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "config/swaggerConfig"

Index

Variables

Functions

Object literals

Variables

Const env

env: string = process.env.APP_ENV || 'development'

Const swaggerSpec

swaggerSpec: object = swaggerJSDoc(options)

Functions

Const host

  • host(): string

Object literals

Const options

options: object

apis

apis: string[] = [path.join(__dirname, '..', 'routers/*.js')]

swaggerDefinition

swaggerDefinition: object

Type declaration

  • basePath: string
  • host: string
  • components: object
    • schemas: object
      • auth: object
        • type: string
        • properties: object
          • errMessage: object
            • description: string
            • example: string
            • type: string
          • statusCode: object
            • example: string
            • type: string
      • success: object
        • type: string
        • properties: object
          • statusCode: object
            • example: string
            • type: string
          • totalRecords: object
            • description: string
            • type: string
          • totalTime: object
            • description: string
            • type: string
  • info: object
    • description: string
    • title: string
    • version: string

Const swaggerDefinition

swaggerDefinition: object

basePath

basePath: string = "/"

host

host: string = host()

components

components: object

schemas

schemas: object

auth

auth: object

type

type: string = "object"

properties

properties: object

errMessage

errMessage: object

description

description: string = "Authentication Failed"

example

example: string = "Authentication Failed"

type

type: string = "string"

statusCode

statusCode: object

example

example: string = "FAILED"

type

type: string = "string"

success

success: object

type

type: string = "object"

properties

properties: object

statusCode

statusCode: object

example

example: string = "SUCCESS"

type

type: string = "string"

totalRecords

totalRecords: object

description

description: string = "Total processed records"

type

type: string = "number"

totalTime

totalTime: object

description

description: string = "Total processed time"

type

type: string = "number"

info

info: object

description

description: string = "W2PS RESTful API"

title

title: string = "W2PS API"

version

version: string = "1.0.0"

Generated using TypeDoc