-
-
Notifications
You must be signed in to change notification settings - Fork 20
/
index.d.ts
49 lines (39 loc) · 933 Bytes
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
declare module 'swagger-routes-express' {
import { Handler, Router } from 'express'
interface Controllers {
[key: string]: Handler
}
interface ConnectorOptions {
security?: {
[key: string]: Handler
}
middleware?: {
[key: string]: Handler
}
onCreateRoute?: (method: string, descriptor: any[]) => void
apiSeparator?: string
notImplemented?: Handler
notFound?: Handler
rootTag?: string
variables?: object
}
interface SummariseOptions {
INVALID_VERSION?: string
}
interface Summary {
info: {
name: string
description: string
version: string
}
paths: {
[key: string]: string[]
}
}
export function connector(
api: Controllers,
apiDefinition: object,
options?: ConnectorOptions
): (router: Router) => void
export function summarise(apiDefinition: object, options?: SummariseOptions): Summary
}