Spaces:
Running
Running
File size: 4,795 Bytes
fe17679 da50ce9 fe17679 da50ce9 fe17679 da50ce9 fe17679 da50ce9 fe17679 da50ce9 fe17679 da50ce9 fe17679 da50ce9 fe17679 da50ce9 fe17679 da50ce9 fe17679 da50ce9 fe17679 |
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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
/**
* Swagger registry class.
*/
class SwaggerRegistry {
public controllersRegistry = new Map<
any,
{
routes: {
propertyKey: string;
path?: string;
method?: "get" | "post" | "put" | "patch" | "delete";
request?: any;
response?: any;
}[];
prefix: string;
tags?: string[];
}
>();
public schemasRegistry = new Map<
any,
{
properties: {
[key: string]: any;
};
propertiesToExclude: string[];
}
>();
public initSchemaIfNotExists(schema: any) {
if (!this.schemasRegistry.has(schema)) {
this.schemasRegistry.set(schema, {
properties: {},
propertiesToExclude: [],
});
}
}
public updateSchemaProperty(props: {
schema: any;
property: string;
newName?: string;
type: any;
}) {
this.initSchemaIfNotExists(props.schema);
const data = this.schemasRegistry.get(props.schema);
data.properties[props.newName || props.property] = { type: props.type };
if (props.newName) {
data.propertiesToExclude.push(props.property);
}
this.schemasRegistry.set(props.schema, data);
}
public initControllerIfNotExists(controller: any, prefix: string = "") {
if (!this.controllersRegistry.has(controller)) {
this.controllersRegistry.set(controller, {
routes: [],
prefix,
});
}
}
public setControllerPrefix(controller: any, prefix: string) {
this.initControllerIfNotExists(controller);
const data = this.controllersRegistry.get(controller);
data.prefix = prefix;
this.controllersRegistry.set(controller, data);
}
public updateRoute(
controller: any,
params: {
propertyKey: string;
path?: string;
method?: "get" | "post" | "put" | "patch" | "delete";
request?: any;
response?: any;
}
) {
this.initControllerIfNotExists(controller);
const data = this.controllersRegistry.get(controller);
// delete undefined keys
Object.keys(params).forEach(
(key) => params[key] === undefined && delete params[key]
);
const route = data.routes.find(
(route) => route.propertyKey === params.propertyKey
);
if (route) {
Object.assign(route, params);
} else {
data.routes.push(params);
}
this.controllersRegistry.set(controller, data);
}
public setControllerTags(controller: any, tags: string[]) {
this.initControllerIfNotExists(controller);
const data = this.controllersRegistry.get(controller);
data.tags = tags;
this.controllersRegistry.set(controller, data);
}
public generateSwaggerDocument() {
const paths: any = {};
this.controllersRegistry.forEach((value) => {
const controllerData = value;
controllerData.routes.forEach((route) => {
route.path = `/api/v1${controllerData.prefix}${route.path}`;
if (!paths[route.path]) {
paths[route.path] = {};
}
paths[route.path][route.method] = {
security: [
{
bearerAuth: [],
},
],
tags: controllerData.tags,
responses: {
200: {
description: "Success",
content: {
"application/json": {
schema: route.response,
},
},
},
},
};
if (route.request) {
paths[route.path][route.method].requestBody = {
content: {
"application/json": {
schema: route.request,
},
},
};
}
if (!paths[route.path].summary) {
paths[route.path].summary = route.propertyKey;
}
if (!paths[route.path].description) {
paths[route.path].description = route.propertyKey;
}
if (!paths[route.path].parameters) {
paths[route.path].parameters = [];
}
if (!paths[route.path].responses) {
paths[route.path].responses = [];
}
});
});
const document = {
openapi: "3.0.0",
info: {
title: "Express TypeScript Swagger",
version: "1.0.0",
description:
"API documentation using Swagger and Express with TypeScript.",
},
servers: [
{
url: "http://localhost:3000",
},
],
security: [
{
bearerAuth: [],
},
],
paths,
components: {
securitySchemes: {
bearerAuth: {
type: "http",
scheme: "bearer",
bearerFormat: "JWT",
},
},
},
};
return document;
}
}
export const swaggerRegistry = new SwaggerRegistry();
|