Class default<T>

Easy rest api helper

Type Parameters

T = DEFAULT_HANDLER

Constructors

constructor

new default<T>(options): default<T>
Type Parameters
- T = DEFAULT_HANDLER
Parameters
- options: IApiOption
Returns default<T>
- Defined in src/lib/index.ts:192

Properties

`Private` apiInfo

apiInfo: IApiInfo<T>

`Private` app

app: any

`Private` config

config: IAPIConfig

`Private` defineAPI

defineAPI: ((options, group?, prefix?) => default<T>)

Type declaration

- (options, group?, prefix?): default<T>
- Parameters
  - options: APIDefine<T>
  - Optional group: string
  - Optional prefix: string
  Returns default<T>

`Private` docsOptions

docsOptions: IDocOptions

`Private` error

error: {
    internalError: ((msg) => Error);
    invalidParameter: ((msg) => Error);
    missingParameter: ((msg) => Error);
}

Type declaration

internalError: ((msg) => Error)
- - (msg): Error
  - Parameters
    - msg: string
    Returns Error
invalidParameter: ((msg) => Error)
- - (msg): Error
  - Parameters
    - msg: string
    Returns Error
missingParameter: ((msg) => Error)
- - (msg): Error
  - Parameters
    - msg: string
    Returns Error

`Private` errorManage

errorManage: ErrorManager

`Private` forceGroup

forceGroup: boolean

`Private` groupInfo

groupInfo: Record<string, IGroupInfo<T>>

`Private` groups

groups: Record<string, string>

`Private` info

info: IApiOptionInfo

`Private` `Optional` mockHandler

mockHandler?: ((data) => T)

Type declaration

- (data): T
- Parameters
  - data: any
  Returns T

`Private` registAPI

registAPI: ((method, path, group?, prefix?) => default<T>)

Type declaration

- (method, path, group?, prefix?): default<T>
- Parameters
  - method: "delete" | "get" | "patch" | "post" | "put"
  - path: string
  - Optional group: string
  - Optional prefix: string
  Returns default<T>

`Private` schemaManage

schemaManage: SchemaManager = ...

`Optional` shareTestData

shareTestData?: any

`Private` testAgent

testAgent: default = ...

`Private` typeManage

typeManage: ValueTypeManager = ...

utils

utils: __module = utils

Accessors

api

get api(): IApiInfo<T>
API实例

Returns IApiInfo<T>
- Defined in src/lib/index.ts:160

errors

get errors(): ErrorManager
错误列表

Returns ErrorManager
- Defined in src/lib/index.ts:174

privateInfo

get privateInfo(): {
    app: any;
    docsOptions: IDocOptions;
    error: {
        internalError: ((msg) => Error);
        invalidParameter: ((msg) => Error);
        missingParameter: ((msg) => Error);
    };
    groupInfo: Record<string, IGroupInfo<T>>;
    groups: Record<string, string>;
    info: IApiOptionInfo;
    mockHandler: undefined | ((data) => T);
}
获取私有变量信息

Returns {
    app: any;
    docsOptions: IDocOptions;
    error: {
        internalError: ((msg) => Error);
        invalidParameter: ((msg) => Error);
        missingParameter: ((msg) => Error);
    };
    groupInfo: Record<string, IGroupInfo<T>>;
    groups: Record<string, string>;
    info: IApiOptionInfo;
    mockHandler: undefined | ((data) => T);
}
- app: any
- docsOptions: IDocOptions
- error: {
      internalError: ((msg) => Error);
      invalidParameter: ((msg) => Error);
      missingParameter: ((msg) => Error);
  }
  - internalError: ((msg) => Error)
    - - (msg): Error
      - Parameters
        msg: string
        Returns Error
  - invalidParameter: ((msg) => Error)
    - - (msg): Error
      - Parameters
        msg: string
        Returns Error
  - missingParameter: ((msg) => Error)
    - - (msg): Error
      - Parameters
        msg: string
        Returns Error
- groupInfo: Record<string, IGroupInfo<T>>
- groups: Record<string, string>
- info: IApiOptionInfo
- mockHandler: undefined | ((data) => T)
- Defined in src/lib/index.ts:145

schema

get schema(): SchemaManager
类型列表

Returns SchemaManager
- Defined in src/lib/index.ts:188

test

get test(): default
测试实例

Returns default
- Defined in src/lib/index.ts:167

type

get type(): ValueTypeManager
类型列表

Returns ValueTypeManager
- Defined in src/lib/index.ts:181

Methods

addDocPlugin

addDocPlugin(name, plugin): void
注册文档生成组件
Parameters
- name: string
- plugin: IDocGeneratePlugin
Returns void
- Defined in src/lib/index.ts:329

afterHooks

afterHooks(fn): void
设置全局 After Hook
Parameters
- fn: T
Returns void
- Defined in src/lib/index.ts:354

apiChecker

apiChecker(): ((schema, params?, query?, body?) => Record<string, any>)
获取Schema检查实例

Returns ((schema, params?, query?, body?) => Record<string, any>)
- - (schema, params?, query?, body?): Record<string, any>
  - Parameters
    - schema: default<any>
    - Optional params: Record<string, any>
    - Optional query: Record<string, any>
    - Optional body: Record<string, any>
    Returns Record<string, any>
- Defined in src/lib/index.ts:383

beforeHooks

beforeHooks(fn): void
设置全局 Before Hook
Parameters
- fn: T
Returns void
- Defined in src/lib/index.ts:346

bindRouter

bindRouter(router, checker): void
绑定路由（加载顺序：beforeHooks -> apiCheckParams -> middlewares -> handler -> afterHooks ）
Parameters
- router: any
  路由
- checker: ((ctx, schema) => T)
  - - (ctx, schema): T
    - Parameters
      ctx: default<T>
      schema: default<T>
      Returns T
Returns void
- Defined in src/lib/index.ts:464

bindRouterToApp

bindRouterToApp(app, Router, checker): void
绑定路由到Express
Parameters
- app: any
  Express App 实例
- Router: any
  Router 对象
- checker: ((ctx, schema) => T)
  - - (ctx, schema): T
    - Parameters
      ctx: default<T>
      schema: default<T>
      Returns T
Returns void
- Defined in src/lib/index.ts:488

buildSwagger

buildSwagger(): any
获取Swagger信息

Returns any
- Defined in src/lib/index.ts:336

checkerExpress

checkerExpress<U, V, W>(ereat, schema): ((req, res, next) => void)
Type Parameters
- U
- V
- W
Parameters
- ereat: default<T>
- schema: default<DEFAULT_HANDLER>
Returns ((req, res, next) => void)
- - (req, res, next): void
  - Parameters
    - req: U
    - res: V
    - next: W
    Returns void
- Defined in src/lib/index.ts:451

checkerLeiWeb

checkerLeiWeb<K>(ereat, schema): ((ctx) => void)
Type Parameters
- K
Parameters
- ereat: default<T>
- schema: default<DEFAULT_HANDLER>
Returns ((ctx) => void)
- - (ctx): void
  - Parameters
    - ctx: K
    Returns void
- Defined in src/lib/index.ts:437

genDocs

genDocs(savePath?, onExit?): void
生成文档
Parameters
- savePath: string = ...
  文档保存路径
- onExit: boolean = true
  是否等待程序退出再保存
Returns void
- Defined in src/lib/index.ts:424

group

group(name, info?): IGruop<T>
获取分组API实例
Parameters
- name: string
- Optional info: IGroupInfoOpt
Returns IGruop<T>
- Defined in src/lib/index.ts:391
group(name, desc?): IGruop<T>
Parameters
- name: string
- Optional desc: string
Returns IGruop<T>
- Defined in src/lib/index.ts:392

initTest

initTest(app, testPath?, docPath?): void
初始化测试系统
Parameters
- app: any
  APP或者serve实例，用于init supertest
- testPath: string = ...
  测试文件路径
- docPath: string = ...
  输出文件路径
Returns void
- Defined in src/lib/index.ts:288

paramsChecker

paramsChecker(): ((name, value, schema) => any)
获取参数检查实例

Returns ((name, value, schema) => any)
- - (name, value, schema): any
  - Parameters
    - name: string
    - value: any
    - schema: ISchemaType
    Returns any
- Defined in src/lib/index.ts:362

responseChecker

responseChecker(): ((data, schema) => IValueResult | ISchemaCheckResult)
返回结果检查

Returns ((data, schema) => IValueResult | ISchemaCheckResult)
- - (data, schema): IValueResult | ISchemaCheckResult
  - Parameters
    - data: any
    - schema: SchemaType | ISchemaType | Record<string, ISchemaType>
    Returns IValueResult | ISchemaCheckResult
- Defined in src/lib/index.ts:375

schemaChecker

schemaChecker(): ((data, schema, requiredOneOf?) => any)
获取Schema检查实例

Returns ((data, schema, requiredOneOf?) => any)
- - (data, schema, requiredOneOf?): any
  - Parameters
    - data: any
    - schema: Record<string, ISchemaType>
    - requiredOneOf: string[] = []
    Returns any
- Defined in src/lib/index.ts:369

setDocOutputForamt

setDocOutputForamt(fn): void
设置文档格式化函数
Parameters
- fn: ((out) => any)
  - - (out): any
    - Parameters
      out: any
      Returns any
Returns void
- Defined in src/lib/index.ts:311

setDocWritter

setDocWritter(fn): void
设置文档格式化函数
Parameters
- fn: IDocWritter
Returns void
- Defined in src/lib/index.ts:318

setFormatOutput

setFormatOutput(fn): void
设置测试格式化函数
Parameters
- fn: ((out) => [null | Error, any])
  - - (out): [null | Error, any]
    - Parameters
      out: any
      Returns [null | Error, any]
Returns void
- Defined in src/lib/index.ts:304

setMockHandler

setMockHandler(fn): void
Parameters
- fn: ((data) => T)
  - - (data): T
    - Parameters
      data: any
      Returns T
Returns void
- Defined in src/lib/index.ts:322

Class default<T>

Type Parameters

T = DEFAULT_HANDLER

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = DEFAULT_HANDLER

Parameters

options: IApiOption

Returns default<T>

Properties

Private apiInfo

Private app

Private config

Private defineAPI

Type declaration

Parameters

options: APIDefine<T>

Optional group: string

Optional prefix: string

Returns default<T>

Private docsOptions

Private error

Type declaration

internalError: ((msg) => Error)

Parameters

msg: string

Returns Error

invalidParameter: ((msg) => Error)

Parameters

msg: string

Returns Error

missingParameter: ((msg) => Error)

Parameters

msg: string

Returns Error

Private errorManage

Private forceGroup

Private groupInfo

Private groups

Private info

Private Optional mockHandler

Type declaration

Parameters

data: any

Returns T

Private registAPI

Type declaration

Parameters

method: "delete" | "get" | "patch" | "post" | "put"

path: string

Optional group: string

Optional prefix: string

Returns default<T>

Private schemaManage

Optional shareTestData

Private testAgent

Private typeManage

utils

Accessors

api

Returns IApiInfo<T>

errors

Returns ErrorManager

privateInfo

app: any

docsOptions: IDocOptions

error: { internalError: ((msg) => Error); invalidParameter: ((msg) => Error); missingParameter: ((msg) => Error); }

internalError: ((msg) => Error)

Parameters

msg: string

Returns Error

invalidParameter: ((msg) => Error)

Parameters

msg: string

`Private` apiInfo

`Private` app

`Private` config

`Private` defineAPI

`Optional` group: string

`Optional` prefix: string

`Private` docsOptions

`Private` error

`Private` errorManage

`Private` forceGroup

`Private` groupInfo

`Private` groups

`Private` info

`Private` `Optional` mockHandler

`Private` registAPI

`Optional` group: string

`Optional` prefix: string

`Private` schemaManage

`Optional` shareTestData

`Private` testAgent

`Private` typeManage

error: {
internalError: ((msg) => Error);
invalidParameter: ((msg) => Error);
missingParameter: ((msg) => Error);
}

`Optional` params: Record<string, any>

`Optional` query: Record<string, any>

`Optional` body: Record<string, any>