UNPKG

tspace-swagger-ui-express

Version:

Auto-generated Swagger-UI API documentation from an Express application.

github.com/thanathip41

thanathip41/tspace-swagger-ui-express

99 lines (98 loc) • 3.34 kB
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
import 'reflect-metadata'; import expressEx, { Application, NextFunction, Request, Response } from "express"; import { TSwagger, TSwaggerDoc } from "./types"; /** * * @param {object} data * @property {object} data.match - { page : string , method : string} * @property {string} data.method * @property {string | null} data.description * @property {boolean | null} data.bearerToken * @property {object | null} data.query * @property {object | null} data.body * @property {object | null} data.files * @property {object | null} data.cookies * @property {array | null} data.responses * * @example * * @Swagger({ * path : "/v1/users", * method : 'GET', * bearerToken : true, * responses : [ * { status : 200 , description : "OK" , example : { id : 'catz' }}, * { status : 400 , description : "Bad request" , example : { message : 'bad request for catz' }} * ] * }) * @returns */ export declare const Swagger: (data: TSwagger) => (target: { constructor: any; }, propertyKey: string) => void; /** * * @param {Application} express Application express() instance * @param {object} doc * @property {string | null} data.path * @property {string | null} data.staticUrl * @property {Array | null} data.controllers * @property {Array | null} data.servers * @property {Array | null} data.tags * @property {string | null} data.openapi * @property {object | null} data.info * @property {object | null} data.cookies * @property {Array | null} data.responses * */ export declare const swaggerYAML: (express: Application, doc?: TSwaggerDoc) => Promise<string>; /** * * @param {Application} express Application express() instance * @param {object} doc * @property {string | null} data.path * @property {string | null} data.staticUrl * @property {Array | null} data.controllers * @property {Array | null} data.servers * @property {Array | null} data.tags * @property {string | null} data.openapi * @property {object | null} data.info * @property {object | null} data.cookies * @property {Array | null} data.responses * */ export declare const swaggerJSON: (express: Application, doc?: TSwaggerDoc) => Promise<string>; /** * * @param {Application} express Application express() instance * @param {object} doc * @property {string | null} data.path * @property {string | null} data.staticUrl * @property {Array | null} data.controllers * @property {Array | null} data.servers * @property {Array | null} data.tags * @property {string | null} data.openapi * @property {object | null} data.info * @property {object | null} data.cookies * @property {Array | null} data.responses * * @example * import express , { Request , Response , NextFunction } from 'express'; * import swagger from 'tspace-swagger-ui-express'; * const app = express() * * app.get("/", (req : Request, res : Response , next : NextFunction) => { * return res.send("Hello, world!") * }) * app.use(swagger(app)) * * const PORT = 3000 * * app.listen(PORT, () => { * console.log(`Server is running on http://localhost:${PORT}`); * }) * * // open the localhost:3000/api/docs */ declare const _default: (express: Application, doc?: TSwaggerDoc) => (req: Request, res: Response, next: NextFunction) => Promise<void | expressEx.Response<any, Record<string, any>>>; export default _default;