@aomex/openapi 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/index.d.ts +50 -0
- package/dist/index.js +249 -0
- package/dist/index.js.map +1 -0
- package/package.json +50 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 geekact
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import * as _aomex_console from '@aomex/console';
|
|
2
|
+
import EventEmitter from 'node:events';
|
|
3
|
+
import { Mode } from 'node:fs';
|
|
4
|
+
import { OpenAPI } from '@aomex/core';
|
|
5
|
+
import { PathToFileOptions } from '@aomex/file-parser';
|
|
6
|
+
|
|
7
|
+
interface OpenapiOptions {
|
|
8
|
+
/**
|
|
9
|
+
* 路由所在目录,与创建WebApp时提供的一致
|
|
10
|
+
*/
|
|
11
|
+
routers: PathToFileOptions;
|
|
12
|
+
/**
|
|
13
|
+
* 文档的一些基础信息
|
|
14
|
+
* @see OpenApiDocs
|
|
15
|
+
*/
|
|
16
|
+
docs?: Omit<OpenAPI.Document, 'paths' | 'openapi' | 'info'> & {
|
|
17
|
+
openapi?: `3.0.${0 | 1 | 2 | 3}`;
|
|
18
|
+
info?: Partial<OpenAPI.Document['info']>;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* 输出到指定文件,支持JSON和yaml格式。默认:`openapi.json`
|
|
22
|
+
*/
|
|
23
|
+
output?: false | string;
|
|
24
|
+
/**
|
|
25
|
+
* 输出文件的权限
|
|
26
|
+
*/
|
|
27
|
+
fileMode?: Mode;
|
|
28
|
+
/**
|
|
29
|
+
* 如果是JSON文件,内容是否需要格式化以方便调试,代价是文件体积增加了,默认:false
|
|
30
|
+
*/
|
|
31
|
+
prettyJson?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* 内容写入文件前的修正回调。如果是框架的问题,请提交issue
|
|
34
|
+
*/
|
|
35
|
+
fix?: (data: OpenAPI.Document) => void;
|
|
36
|
+
/**
|
|
37
|
+
* 执行日志流输出
|
|
38
|
+
*/
|
|
39
|
+
emitter: EventEmitter;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
declare const openapi: (options: Omit<OpenapiOptions, 'emitter'> & {
|
|
43
|
+
renderWarnings?: boolean;
|
|
44
|
+
commandName?: string;
|
|
45
|
+
showInHelp?: boolean;
|
|
46
|
+
summary?: string;
|
|
47
|
+
description?: string;
|
|
48
|
+
}) => _aomex_console.ConsoleChain<object>;
|
|
49
|
+
|
|
50
|
+
export { openapi };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
// src/openapi.ts
|
|
2
|
+
import EventEmitter2 from "node:events";
|
|
3
|
+
import { chain, middleware as middleware2 } from "@aomex/core";
|
|
4
|
+
import ora from "ora";
|
|
5
|
+
|
|
6
|
+
// src/openapi-to-help.ts
|
|
7
|
+
import { middleware } from "@aomex/core";
|
|
8
|
+
import { color } from "@aomex/helper";
|
|
9
|
+
var openapiToHelp = (commandName, summary, description, showInHelp = true) => middleware.help(async (ctx, next) => {
|
|
10
|
+
const { status, yargs } = ctx.cli;
|
|
11
|
+
switch (status) {
|
|
12
|
+
case "show-all":
|
|
13
|
+
yargs.command(commandName, summary || "\u751F\u6210openapi\u6807\u51C6\u6587\u6863");
|
|
14
|
+
return next();
|
|
15
|
+
case "show-detail":
|
|
16
|
+
if (!showInHelp || ctx.request.command !== commandName) {
|
|
17
|
+
return next();
|
|
18
|
+
}
|
|
19
|
+
yargs.usage(
|
|
20
|
+
`aomex ${commandName} [options]${description ? "\n\n" + color.bold(description) : ""}`
|
|
21
|
+
);
|
|
22
|
+
ctx.response.commandMatched = true;
|
|
23
|
+
return;
|
|
24
|
+
default:
|
|
25
|
+
const _ = status;
|
|
26
|
+
assert(_);
|
|
27
|
+
}
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
// src/generate-openapi.ts
|
|
31
|
+
import EventEmitter from "node:events";
|
|
32
|
+
import { readPackageUp } from "read-pkg-up";
|
|
33
|
+
import { filesize } from "filesize";
|
|
34
|
+
import { Chain } from "@aomex/core";
|
|
35
|
+
import { color as color2 } from "@aomex/helper";
|
|
36
|
+
import {
|
|
37
|
+
fileToModules,
|
|
38
|
+
pathToFiles
|
|
39
|
+
} from "@aomex/file-parser";
|
|
40
|
+
import { WebMiddleware } from "@aomex/web";
|
|
41
|
+
import { Router } from "@aomex/web-router";
|
|
42
|
+
import validate from "ibm-openapi-validator";
|
|
43
|
+
import path from "node:path";
|
|
44
|
+
import { mkdir, writeFile } from "node:fs/promises";
|
|
45
|
+
import yaml from "yaml";
|
|
46
|
+
var generateOpenapi = async (config) => {
|
|
47
|
+
const emitter = config.emitter || new EventEmitter();
|
|
48
|
+
let msg = "";
|
|
49
|
+
emitter.emit("start");
|
|
50
|
+
emitter.emit("msg", "\u521D\u59CB\u5316");
|
|
51
|
+
const document = JSON.parse(
|
|
52
|
+
JSON.stringify(config.docs || {})
|
|
53
|
+
);
|
|
54
|
+
{
|
|
55
|
+
document.openapi ||= "3.0.3";
|
|
56
|
+
document.tags ||= [];
|
|
57
|
+
document.paths = {};
|
|
58
|
+
document.info.title ||= (await readPackageUp())?.packageJson.name || "API\u6587\u6863";
|
|
59
|
+
document.info.version ||= (await readPackageUp())?.packageJson.version || "0.0.0";
|
|
60
|
+
}
|
|
61
|
+
emitter.emit("msg", msg = "\u641C\u7D22\u8DEF\u7531\u6587\u4EF6");
|
|
62
|
+
const files = await pathToFiles(config.routers);
|
|
63
|
+
emitter.emit("msg", msg = "\u89E3\u6790\u8DEF\u7531");
|
|
64
|
+
const usedTags = [];
|
|
65
|
+
for (const file of files) {
|
|
66
|
+
emitter.emit("replace", msg + path.relative(process.cwd(), file));
|
|
67
|
+
await new Promise((resolve) => setTimeout(resolve, 50));
|
|
68
|
+
const routers = await fileToModules(
|
|
69
|
+
[file],
|
|
70
|
+
(item) => !!item && item instanceof Router
|
|
71
|
+
);
|
|
72
|
+
for (const router of routers) {
|
|
73
|
+
const groupMiddlewareList = Chain.flatten(Router.getChain(router));
|
|
74
|
+
const builders = Router.getBuilders(router);
|
|
75
|
+
for (const builder of builders) {
|
|
76
|
+
for (const uri of builder.uris) {
|
|
77
|
+
const pathItem = document.paths[normalizePath(uri)] ||= {};
|
|
78
|
+
let methods = builder.methods;
|
|
79
|
+
if (methods.includes("GET") && methods.includes("HEAD")) {
|
|
80
|
+
methods = methods.filter((method) => method !== "HEAD");
|
|
81
|
+
}
|
|
82
|
+
for (const method of methods) {
|
|
83
|
+
const pathItemInMethod = pathItem[method.toLowerCase()] = {
|
|
84
|
+
tags: [getTagByFilename(file)],
|
|
85
|
+
responses: {}
|
|
86
|
+
};
|
|
87
|
+
for (const middleware3 of groupMiddlewareList.concat(
|
|
88
|
+
Chain.flatten(builder.chain)
|
|
89
|
+
)) {
|
|
90
|
+
if (middleware3 instanceof WebMiddleware) {
|
|
91
|
+
middleware3.toDocument({
|
|
92
|
+
document,
|
|
93
|
+
pathItem,
|
|
94
|
+
pathItemInMethod
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
if (Object.keys(pathItemInMethod.responses).length === 0) {
|
|
99
|
+
pathItemInMethod.responses = {
|
|
100
|
+
default: {
|
|
101
|
+
description: ""
|
|
102
|
+
}
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
usedTags.push(...pathItemInMethod.tags);
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
emitter.emit("replace", msg);
|
|
112
|
+
{
|
|
113
|
+
emitter.emit("msg", msg = "\u624B\u52A8\u4FEE\u590D\u6587\u6863");
|
|
114
|
+
if (config.fix) {
|
|
115
|
+
config.fix(document);
|
|
116
|
+
} else {
|
|
117
|
+
emitter.emit("replace", skip(msg));
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
{
|
|
121
|
+
emitter.emit("msg", msg = "\u6587\u6863\u5185\u5BB9\u6E05\u7406\u5E76\u6574\u5408");
|
|
122
|
+
const tagDefinitions = document.tags.filter(
|
|
123
|
+
({ name: tag }) => usedTags.includes(tag)
|
|
124
|
+
);
|
|
125
|
+
const definedTags = tagDefinitions.map((item) => item.name);
|
|
126
|
+
[...new Set(usedTags)].sort().forEach((tag) => {
|
|
127
|
+
if (!definedTags.includes(tag)) {
|
|
128
|
+
tagDefinitions.push({
|
|
129
|
+
name: tag
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
});
|
|
133
|
+
document.tags = tagDefinitions;
|
|
134
|
+
}
|
|
135
|
+
{
|
|
136
|
+
emitter.emit("msg", msg = "\u4FDD\u5B58\u5230\u6587\u4EF6");
|
|
137
|
+
let distFile = config.output === false ? false : config.output || "openapi.json";
|
|
138
|
+
if (distFile) {
|
|
139
|
+
distFile = path.resolve(distFile);
|
|
140
|
+
await mkdir(path.dirname(distFile), {
|
|
141
|
+
recursive: true
|
|
142
|
+
});
|
|
143
|
+
const content = [".yml", ".yaml"].includes(path.extname(distFile)) ? yaml.stringify(document) : JSON.stringify(document, null, config.prettyJson ? 2 : void 0);
|
|
144
|
+
await writeFile(distFile, content, {
|
|
145
|
+
mode: config.fileMode
|
|
146
|
+
});
|
|
147
|
+
emitter.emit(
|
|
148
|
+
"replace",
|
|
149
|
+
msg + path.relative(process.cwd(), distFile) + " " + filesize(Buffer.byteLength(content), {
|
|
150
|
+
spacer: ""
|
|
151
|
+
}),
|
|
152
|
+
true
|
|
153
|
+
);
|
|
154
|
+
} else {
|
|
155
|
+
emitter.emit("replace", skip(msg));
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
emitter.emit("msg", msg = "\u9A8C\u8BC1openapi\u6587\u6863");
|
|
159
|
+
const result = await validate(document);
|
|
160
|
+
{
|
|
161
|
+
const summary = [];
|
|
162
|
+
if (result.errors?.length) {
|
|
163
|
+
summary.push(`${result.errors.length}\u4E2A\u9519\u8BEF`);
|
|
164
|
+
}
|
|
165
|
+
if (result.warnings?.length) {
|
|
166
|
+
summary.push(`${result.warnings.length}\u4E2A\u8B66\u544A`);
|
|
167
|
+
}
|
|
168
|
+
summary.length && emitter.emit("replace", msg + color2.yellow(summary.join("\uFF0C")));
|
|
169
|
+
emitter.emit(
|
|
170
|
+
"end",
|
|
171
|
+
result.errors?.length ? "fail" : result.warnings?.length ? "warn" : "ok"
|
|
172
|
+
);
|
|
173
|
+
}
|
|
174
|
+
return {
|
|
175
|
+
document: JSON.parse(JSON.stringify(document)),
|
|
176
|
+
result: {
|
|
177
|
+
errors: result.errors || [],
|
|
178
|
+
warnings: result.warnings || []
|
|
179
|
+
}
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
var skip = (message) => message + "\uFF1A" + color2.gray("[\u8DF3\u8FC7]");
|
|
183
|
+
var normalizePath = (uri) => {
|
|
184
|
+
return uri.replace(/:([a-z0-9_?]+)/gi, (_, $1) => {
|
|
185
|
+
return `{${$1.replace(/[?]/g, "")}}`;
|
|
186
|
+
});
|
|
187
|
+
};
|
|
188
|
+
var getTagByFilename = (file) => {
|
|
189
|
+
return path.basename(file).replace(/\..+$/, "");
|
|
190
|
+
};
|
|
191
|
+
|
|
192
|
+
// src/openapi.ts
|
|
193
|
+
var openapi = (options) => {
|
|
194
|
+
const commandName = options.commandName || "openapi";
|
|
195
|
+
return chain.console.mount(
|
|
196
|
+
openapiToHelp(
|
|
197
|
+
commandName,
|
|
198
|
+
options.summary,
|
|
199
|
+
options.description,
|
|
200
|
+
options.showInHelp
|
|
201
|
+
)
|
|
202
|
+
).mount(
|
|
203
|
+
middleware2.console(async (ctx, next) => {
|
|
204
|
+
if (ctx.request.command !== commandName)
|
|
205
|
+
return next();
|
|
206
|
+
const emitter = new EventEmitter2();
|
|
207
|
+
const spinner = ora();
|
|
208
|
+
emitter.on("msg", (msg) => {
|
|
209
|
+
if (spinner.isSpinning)
|
|
210
|
+
spinner.succeed();
|
|
211
|
+
spinner.start(msg);
|
|
212
|
+
}).on("replace", (msg) => {
|
|
213
|
+
spinner.text = msg;
|
|
214
|
+
}).on("end", (status) => {
|
|
215
|
+
if (status === "succeed" || status === "fail" || status === "warn") {
|
|
216
|
+
spinner[status]();
|
|
217
|
+
}
|
|
218
|
+
});
|
|
219
|
+
let result;
|
|
220
|
+
try {
|
|
221
|
+
result = (await generateOpenapi({ ...options, emitter })).result;
|
|
222
|
+
} catch (e) {
|
|
223
|
+
spinner.fail();
|
|
224
|
+
throw e;
|
|
225
|
+
}
|
|
226
|
+
if (result.errors.length) {
|
|
227
|
+
spinner.indent = 2;
|
|
228
|
+
result.errors.forEach((item) => {
|
|
229
|
+
spinner.fail(formatValidateMessage(item));
|
|
230
|
+
});
|
|
231
|
+
}
|
|
232
|
+
if (options.renderWarnings && result.warnings.length) {
|
|
233
|
+
spinner.indent = 2;
|
|
234
|
+
result.warnings.forEach((item) => {
|
|
235
|
+
spinner.warn(formatValidateMessage(item));
|
|
236
|
+
});
|
|
237
|
+
}
|
|
238
|
+
})
|
|
239
|
+
);
|
|
240
|
+
};
|
|
241
|
+
var formatValidateMessage = (item) => {
|
|
242
|
+
let pathname = item.path.length ? item.path.join(".") : "";
|
|
243
|
+
pathname = pathname && !item.message.includes(`"${pathname}"`) ? `[${pathname}] ` : "";
|
|
244
|
+
return `${pathname}${item.message}`;
|
|
245
|
+
};
|
|
246
|
+
export {
|
|
247
|
+
openapi
|
|
248
|
+
};
|
|
249
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/openapi.ts","../src/openapi-to-help.ts","../src/generate-openapi.ts"],"sourcesContent":["import EventEmitter from 'node:events';\nimport { chain, middleware } from '@aomex/core';\nimport ora, { type Ora } from 'ora';\nimport { openapiToHelp } from './openapi-to-help';\nimport {\n generateOpenapi,\n type OpenapiValidateResultItem,\n type OpenapiOptions,\n type OpenapiValidateResult,\n} from './generate-openapi';\n\nexport const openapi = (\n options: Omit<OpenapiOptions, 'emitter'> & {\n renderWarnings?: boolean;\n commandName?: string;\n showInHelp?: boolean;\n summary?: string;\n description?: string;\n },\n) => {\n const commandName = options.commandName || 'openapi';\n\n return chain.console\n .mount(\n openapiToHelp(\n commandName,\n options.summary,\n options.description,\n options.showInHelp,\n ),\n )\n .mount(\n middleware.console(async (ctx, next) => {\n if (ctx.request.command !== commandName) return next();\n\n const emitter = new EventEmitter();\n const spinner: Ora = ora();\n\n emitter\n .on('msg', (msg) => {\n if (spinner.isSpinning) spinner.succeed();\n spinner.start(msg);\n })\n .on('replace', (msg) => {\n spinner.text = msg;\n })\n .on('end', (status: string) => {\n if (\n status === 'succeed' ||\n status === 'fail' ||\n status === 'warn'\n ) {\n spinner[status]();\n }\n });\n\n let result: OpenapiValidateResult;\n try {\n result = (await generateOpenapi({ ...options, emitter })).result;\n } catch (e) {\n spinner.fail();\n throw e;\n }\n\n if (result.errors.length) {\n spinner.indent = 2;\n result.errors.forEach((item) => {\n spinner.fail(formatValidateMessage(item));\n });\n }\n\n if (options.renderWarnings && result.warnings.length) {\n spinner.indent = 2;\n result.warnings.forEach((item) => {\n spinner.warn(formatValidateMessage(item));\n });\n }\n }),\n );\n};\n\nconst formatValidateMessage = (item: OpenapiValidateResultItem) => {\n let pathname = item.path.length ? item.path.join('.') : '';\n pathname =\n pathname && !item.message.includes(`\"${pathname}\"`) ? `[${pathname}] ` : '';\n return `${pathname}${item.message}`;\n};\n","import { middleware } from '@aomex/core';\nimport { color } from '@aomex/helper';\n\nexport const openapiToHelp = (\n commandName: string,\n summary?: string,\n description?: string,\n showInHelp: boolean = true,\n) =>\n middleware.help(async (ctx, next) => {\n const { status, yargs } = ctx.cli;\n\n switch (status) {\n case 'show-all':\n yargs.command(commandName, summary || '生成openapi标准文档');\n return next();\n case 'show-detail':\n if (!showInHelp || ctx.request.command !== commandName) {\n return next();\n }\n\n yargs.usage(\n `aomex ${commandName} [options]${\n description ? '\\n\\n' + color.bold(description) : ''\n }`,\n );\n ctx.response.commandMatched = true;\n return;\n default:\n const _: never = status;\n assert(_);\n }\n });\n","import EventEmitter from 'node:events';\nimport type { Mode } from 'node:fs';\nimport { readPackageUp } from 'read-pkg-up';\nimport { filesize } from 'filesize';\nimport { Chain, OpenAPI } from '@aomex/core';\nimport { color } from '@aomex/helper';\nimport {\n fileToModules,\n type PathToFileOptions,\n pathToFiles,\n} from '@aomex/file-parser';\nimport { WebMiddleware } from '@aomex/web';\nimport { Router } from '@aomex/web-router';\nimport validate from 'ibm-openapi-validator';\nimport path from 'node:path';\nimport { mkdir, writeFile } from 'node:fs/promises';\nimport yaml from 'yaml';\n\nexport interface OpenapiValidateResultItem {\n path: string[];\n message: string;\n rule: string;\n}\n\nexport interface OpenapiValidateResult {\n errors: OpenapiValidateResultItem[];\n warnings: OpenapiValidateResultItem[];\n}\n\nexport interface OpenapiOptions {\n /**\n * 路由所在目录,与创建WebApp时提供的一致\n */\n routers: PathToFileOptions;\n /**\n * 文档的一些基础信息\n * @see OpenApiDocs\n */\n docs?: Omit<OpenAPI.Document, 'paths' | 'openapi' | 'info'> & {\n openapi?: `3.0.${0 | 1 | 2 | 3}`;\n info?: Partial<OpenAPI.Document['info']>;\n };\n /**\n * 输出到指定文件,支持JSON和yaml格式。默认:`openapi.json`\n */\n output?: false | string;\n /**\n * 输出文件的权限\n */\n fileMode?: Mode;\n /**\n * 如果是JSON文件,内容是否需要格式化以方便调试,代价是文件体积增加了,默认:false\n */\n prettyJson?: boolean;\n /**\n * 内容写入文件前的修正回调。如果是框架的问题,请提交issue\n */\n fix?: (data: OpenAPI.Document) => void;\n /**\n * 执行日志流输出\n */\n emitter: EventEmitter;\n}\n\nexport const generateOpenapi = async (\n config: OpenapiOptions,\n): Promise<{\n document: OpenAPI.Document;\n result: OpenapiValidateResult;\n}> => {\n const emitter = config.emitter || new EventEmitter();\n let msg = '';\n\n emitter.emit('start');\n emitter.emit('msg', '初始化');\n const document: OpenAPI.Document = JSON.parse(\n JSON.stringify(config.docs || {}),\n );\n\n {\n document.openapi ||= '3.0.3';\n document.tags ||= [];\n document.paths = {};\n document.info.title ||=\n (await readPackageUp())?.packageJson.name || 'API文档';\n document.info.version ||=\n (await readPackageUp())?.packageJson.version || '0.0.0';\n }\n\n emitter.emit('msg', (msg = '搜索路由文件'));\n const files = await pathToFiles(config.routers);\n emitter.emit('msg', (msg = '解析路由'));\n const usedTags: string[] = [];\n for (const file of files) {\n emitter.emit('replace', msg + path.relative(process.cwd(), file));\n await new Promise((resolve) => setTimeout(resolve, 50));\n\n const routers = await fileToModules<Router>(\n [file],\n (item) => !!item && item instanceof Router,\n );\n for (const router of routers) {\n const groupMiddlewareList = Chain.flatten(Router.getChain(router));\n const builders = Router.getBuilders(router);\n\n for (const builder of builders) {\n for (const uri of builder.uris) {\n const pathItem = (document.paths[normalizePath(uri)] ||= {});\n let methods = builder.methods;\n\n if (methods.includes('GET') && methods.includes('HEAD')) {\n methods = methods.filter((method) => method !== 'HEAD');\n }\n\n for (const method of methods) {\n const pathItemInMethod: OpenAPI.OperationObject = (pathItem[\n method.toLowerCase() as `${Lowercase<typeof method>}`\n ] = {\n tags: [getTagByFilename(file)],\n responses: {},\n });\n\n for (const middleware of groupMiddlewareList.concat(\n Chain.flatten(builder.chain),\n )) {\n if (middleware instanceof WebMiddleware) {\n middleware.toDocument({\n document,\n pathItem,\n pathItemInMethod,\n });\n }\n }\n\n if (Object.keys(pathItemInMethod.responses).length === 0) {\n pathItemInMethod.responses = {\n default: {\n description: '',\n },\n };\n }\n\n usedTags.push(...pathItemInMethod.tags!);\n }\n }\n }\n }\n }\n emitter.emit('replace', msg);\n\n {\n emitter.emit('msg', (msg = '手动修复文档'));\n if (config.fix) {\n config.fix(document);\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n {\n emitter.emit('msg', (msg = '文档内容清理并整合'));\n const tagDefinitions = document.tags!.filter(({ name: tag }) =>\n usedTags.includes(tag),\n );\n const definedTags = tagDefinitions.map((item) => item.name);\n [...new Set(usedTags)].sort().forEach((tag) => {\n if (!definedTags.includes(tag)) {\n tagDefinitions.push({\n name: tag,\n });\n }\n });\n document.tags = tagDefinitions;\n }\n\n {\n emitter.emit('msg', (msg = '保存到文件'));\n let distFile: typeof config.output =\n config.output === false ? false : config.output || 'openapi.json';\n if (distFile) {\n distFile = path.resolve(distFile);\n await mkdir(path.dirname(distFile), {\n recursive: true,\n });\n\n const content = ['.yml', '.yaml'].includes(path.extname(distFile))\n ? yaml.stringify(document)\n : JSON.stringify(document, null, config.prettyJson ? 2 : undefined);\n\n await writeFile(distFile, content, {\n mode: config.fileMode,\n });\n emitter.emit(\n 'replace',\n msg +\n path.relative(process.cwd(), distFile) +\n ' ' +\n filesize(Buffer.byteLength(content), {\n spacer: '',\n }),\n true,\n );\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n emitter.emit('msg', (msg = '验证openapi文档'));\n const result = (await validate(document)) as OpenapiValidateResult;\n\n {\n const summary: string[] = [];\n if (result.errors?.length) {\n summary.push(`${result.errors.length}个错误`);\n }\n if (result.warnings?.length) {\n summary.push(`${result.warnings.length}个警告`);\n }\n summary.length &&\n emitter.emit('replace', msg + color.yellow(summary.join(',')));\n\n emitter.emit(\n 'end',\n result.errors?.length ? 'fail' : result.warnings?.length ? 'warn' : 'ok',\n );\n }\n\n return {\n document: JSON.parse(JSON.stringify(document)),\n result: {\n errors: result.errors || [],\n warnings: result.warnings || [],\n },\n };\n};\n\nconst skip = (message: string) => message + ':' + color.gray('[跳过]');\n\nconst normalizePath = (uri: string) => {\n return uri.replace(/:([a-z0-9_?]+)/gi, (_, $1) => {\n return `{${$1.replace(/[?]/g, '')}}`;\n });\n};\n\nconst getTagByFilename = (file: string) => {\n return path.basename(file).replace(/\\..+$/, '');\n};\n"],"mappings":";AAAA,OAAOA,mBAAkB;AACzB,SAAS,OAAO,cAAAC,mBAAkB;AAClC,OAAO,SAAuB;;;ACF9B,SAAS,kBAAkB;AAC3B,SAAS,aAAa;AAEf,IAAM,gBAAgB,CAC3B,aACA,SACA,aACA,aAAsB,SAEtB,WAAW,KAAK,OAAO,KAAK,SAAS;AACnC,QAAM,EAAE,QAAQ,MAAM,IAAI,IAAI;AAE9B,UAAQ,QAAQ;AAAA,IACd,KAAK;AACH,YAAM,QAAQ,aAAa,WAAW,6CAAe;AACrD,aAAO,KAAK;AAAA,IACd,KAAK;AACH,UAAI,CAAC,cAAc,IAAI,QAAQ,YAAY,aAAa;AACtD,eAAO,KAAK;AAAA,MACd;AAEA,YAAM;AAAA,QACJ,SAAS,wBACP,cAAc,SAAS,MAAM,KAAK,WAAW,IAAI;AAAA,MAErD;AACA,UAAI,SAAS,iBAAiB;AAC9B;AAAA,IACF;AACE,YAAM,IAAW;AACjB,aAAO,CAAC;AAAA,EACZ;AACF,CAAC;;;AChCH,OAAO,kBAAkB;AAEzB,SAAS,qBAAqB;AAC9B,SAAS,gBAAgB;AACzB,SAAS,aAAsB;AAC/B,SAAS,SAAAC,cAAa;AACtB;AAAA,EACE;AAAA,EAEA;AAAA,OACK;AACP,SAAS,qBAAqB;AAC9B,SAAS,cAAc;AACvB,OAAO,cAAc;AACrB,OAAO,UAAU;AACjB,SAAS,OAAO,iBAAiB;AACjC,OAAO,UAAU;AAgDV,IAAM,kBAAkB,OAC7B,WAII;AACJ,QAAM,UAAU,OAAO,WAAW,IAAI,aAAa;AACnD,MAAI,MAAM;AAEV,UAAQ,KAAK,OAAO;AACpB,UAAQ,KAAK,OAAO,oBAAK;AACzB,QAAM,WAA6B,KAAK;AAAA,IACtC,KAAK,UAAU,OAAO,QAAQ,CAAC,CAAC;AAAA,EAClC;AAEA;AACE,aAAS,YAAY;AACrB,aAAS,SAAS,CAAC;AACnB,aAAS,QAAQ,CAAC;AAClB,aAAS,KAAK,WACX,MAAM,cAAc,IAAI,YAAY,QAAQ;AAC/C,aAAS,KAAK,aACX,MAAM,cAAc,IAAI,YAAY,WAAW;AAAA,EACpD;AAEA,UAAQ,KAAK,OAAQ,MAAM,sCAAS;AACpC,QAAM,QAAQ,MAAM,YAAY,OAAO,OAAO;AAC9C,UAAQ,KAAK,OAAQ,MAAM,0BAAO;AAClC,QAAM,WAAqB,CAAC;AAC5B,aAAW,QAAQ,OAAO;AACxB,YAAQ,KAAK,WAAW,MAAM,KAAK,SAAS,QAAQ,IAAI,GAAG,IAAI,CAAC;AAChE,UAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,EAAE,CAAC;AAEtD,UAAM,UAAU,MAAM;AAAA,MACpB,CAAC,IAAI;AAAA,MACL,CAAC,SAAS,CAAC,CAAC,QAAQ,gBAAgB;AAAA,IACtC;AACA,eAAW,UAAU,SAAS;AAC5B,YAAM,sBAAsB,MAAM,QAAQ,OAAO,SAAS,MAAM,CAAC;AACjE,YAAM,WAAW,OAAO,YAAY,MAAM;AAE1C,iBAAW,WAAW,UAAU;AAC9B,mBAAW,OAAO,QAAQ,MAAM;AAC9B,gBAAM,WAAY,SAAS,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC;AAC1D,cAAI,UAAU,QAAQ;AAEtB,cAAI,QAAQ,SAAS,KAAK,KAAK,QAAQ,SAAS,MAAM,GAAG;AACvD,sBAAU,QAAQ,OAAO,CAAC,WAAW,WAAW,MAAM;AAAA,UACxD;AAEA,qBAAW,UAAU,SAAS;AAC5B,kBAAM,mBAA6C,SACjD,OAAO,YAAY,CACrB,IAAI;AAAA,cACF,MAAM,CAAC,iBAAiB,IAAI,CAAC;AAAA,cAC7B,WAAW,CAAC;AAAA,YACd;AAEA,uBAAWC,eAAc,oBAAoB;AAAA,cAC3C,MAAM,QAAQ,QAAQ,KAAK;AAAA,YAC7B,GAAG;AACD,kBAAIA,uBAAsB,eAAe;AACvC,gBAAAA,YAAW,WAAW;AAAA,kBACpB;AAAA,kBACA;AAAA,kBACA;AAAA,gBACF,CAAC;AAAA,cACH;AAAA,YACF;AAEA,gBAAI,OAAO,KAAK,iBAAiB,SAAS,EAAE,WAAW,GAAG;AACxD,+BAAiB,YAAY;AAAA,gBAC3B,SAAS;AAAA,kBACP,aAAa;AAAA,gBACf;AAAA,cACF;AAAA,YACF;AAEA,qBAAS,KAAK,GAAG,iBAAiB,IAAK;AAAA,UACzC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,UAAQ,KAAK,WAAW,GAAG;AAE3B;AACE,YAAQ,KAAK,OAAQ,MAAM,sCAAS;AACpC,QAAI,OAAO,KAAK;AACd,aAAO,IAAI,QAAQ;AAAA,IACrB,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,wDAAY;AACvC,UAAM,iBAAiB,SAAS,KAAM;AAAA,MAAO,CAAC,EAAE,MAAM,IAAI,MACxD,SAAS,SAAS,GAAG;AAAA,IACvB;AACA,UAAM,cAAc,eAAe,IAAI,CAAC,SAAS,KAAK,IAAI;AAC1D,KAAC,GAAG,IAAI,IAAI,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ;AAC7C,UAAI,CAAC,YAAY,SAAS,GAAG,GAAG;AAC9B,uBAAe,KAAK;AAAA,UAClB,MAAM;AAAA,QACR,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AACD,aAAS,OAAO;AAAA,EAClB;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,gCAAQ;AACnC,QAAI,WACF,OAAO,WAAW,QAAQ,QAAQ,OAAO,UAAU;AACrD,QAAI,UAAU;AACZ,iBAAW,KAAK,QAAQ,QAAQ;AAChC,YAAM,MAAM,KAAK,QAAQ,QAAQ,GAAG;AAAA,QAClC,WAAW;AAAA,MACb,CAAC;AAED,YAAM,UAAU,CAAC,QAAQ,OAAO,EAAE,SAAS,KAAK,QAAQ,QAAQ,CAAC,IAC7D,KAAK,UAAU,QAAQ,IACvB,KAAK,UAAU,UAAU,MAAM,OAAO,aAAa,IAAI,MAAS;AAEpE,YAAM,UAAU,UAAU,SAAS;AAAA,QACjC,MAAM,OAAO;AAAA,MACf,CAAC;AACD,cAAQ;AAAA,QACN;AAAA,QACA,MACE,KAAK,SAAS,QAAQ,IAAI,GAAG,QAAQ,IACrC,MACA,SAAS,OAAO,WAAW,OAAO,GAAG;AAAA,UACnC,QAAQ;AAAA,QACV,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA,UAAQ,KAAK,OAAQ,MAAM,iCAAc;AACzC,QAAM,SAAU,MAAM,SAAS,QAAQ;AAEvC;AACE,UAAM,UAAoB,CAAC;AAC3B,QAAI,OAAO,QAAQ,QAAQ;AACzB,cAAQ,KAAK,GAAG,OAAO,OAAO,0BAAW;AAAA,IAC3C;AACA,QAAI,OAAO,UAAU,QAAQ;AAC3B,cAAQ,KAAK,GAAG,OAAO,SAAS,0BAAW;AAAA,IAC7C;AACA,YAAQ,UACN,QAAQ,KAAK,WAAW,MAAMD,OAAM,OAAO,QAAQ,KAAK,QAAG,CAAC,CAAC;AAE/D,YAAQ;AAAA,MACN;AAAA,MACA,OAAO,QAAQ,SAAS,SAAS,OAAO,UAAU,SAAS,SAAS;AAAA,IACtE;AAAA,EACF;AAEA,SAAO;AAAA,IACL,UAAU,KAAK,MAAM,KAAK,UAAU,QAAQ,CAAC;AAAA,IAC7C,QAAQ;AAAA,MACN,QAAQ,OAAO,UAAU,CAAC;AAAA,MAC1B,UAAU,OAAO,YAAY,CAAC;AAAA,IAChC;AAAA,EACF;AACF;AAEA,IAAM,OAAO,CAAC,YAAoB,UAAU,WAAMA,OAAM,KAAK,gBAAM;AAEnE,IAAM,gBAAgB,CAAC,QAAgB;AACrC,SAAO,IAAI,QAAQ,oBAAoB,CAAC,GAAG,OAAO;AAChD,WAAO,IAAI,GAAG,QAAQ,QAAQ,EAAE;AAAA,EAClC,CAAC;AACH;AAEA,IAAM,mBAAmB,CAAC,SAAiB;AACzC,SAAO,KAAK,SAAS,IAAI,EAAE,QAAQ,SAAS,EAAE;AAChD;;;AF3OO,IAAM,UAAU,CACrB,YAOG;AACH,QAAM,cAAc,QAAQ,eAAe;AAE3C,SAAO,MAAM,QACV;AAAA,IACC;AAAA,MACE;AAAA,MACA,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,QAAQ;AAAA,IACV;AAAA,EACF,EACC;AAAA,IACCE,YAAW,QAAQ,OAAO,KAAK,SAAS;AACtC,UAAI,IAAI,QAAQ,YAAY;AAAa,eAAO,KAAK;AAErD,YAAM,UAAU,IAAIC,cAAa;AACjC,YAAM,UAAe,IAAI;AAEzB,cACG,GAAG,OAAO,CAAC,QAAQ;AAClB,YAAI,QAAQ;AAAY,kBAAQ,QAAQ;AACxC,gBAAQ,MAAM,GAAG;AAAA,MACnB,CAAC,EACA,GAAG,WAAW,CAAC,QAAQ;AACtB,gBAAQ,OAAO;AAAA,MACjB,CAAC,EACA,GAAG,OAAO,CAAC,WAAmB;AAC7B,YACE,WAAW,aACX,WAAW,UACX,WAAW,QACX;AACA,kBAAQ,MAAM,EAAE;AAAA,QAClB;AAAA,MACF,CAAC;AAEH,UAAI;AACJ,UAAI;AACF,kBAAU,MAAM,gBAAgB,EAAE,GAAG,SAAS,QAAQ,CAAC,GAAG;AAAA,MAC5D,SAAS,GAAP;AACA,gBAAQ,KAAK;AACb,cAAM;AAAA,MACR;AAEA,UAAI,OAAO,OAAO,QAAQ;AACxB,gBAAQ,SAAS;AACjB,eAAO,OAAO,QAAQ,CAAC,SAAS;AAC9B,kBAAQ,KAAK,sBAAsB,IAAI,CAAC;AAAA,QAC1C,CAAC;AAAA,MACH;AAEA,UAAI,QAAQ,kBAAkB,OAAO,SAAS,QAAQ;AACpD,gBAAQ,SAAS;AACjB,eAAO,SAAS,QAAQ,CAAC,SAAS;AAChC,kBAAQ,KAAK,sBAAsB,IAAI,CAAC;AAAA,QAC1C,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AACJ;AAEA,IAAM,wBAAwB,CAAC,SAAoC;AACjE,MAAI,WAAW,KAAK,KAAK,SAAS,KAAK,KAAK,KAAK,GAAG,IAAI;AACxD,aACE,YAAY,CAAC,KAAK,QAAQ,SAAS,IAAI,WAAW,IAAI,IAAI,eAAe;AAC3E,SAAO,GAAG,WAAW,KAAK;AAC5B;","names":["EventEmitter","middleware","color","middleware","middleware","EventEmitter"]}
|
package/package.json
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@aomex/openapi",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"types": "dist/index.d.ts",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": {
|
|
9
|
+
"types": "./dist/index.d.ts",
|
|
10
|
+
"import": "./dist/index.js"
|
|
11
|
+
},
|
|
12
|
+
"./package.json": "./package.json"
|
|
13
|
+
},
|
|
14
|
+
"publishConfig": {
|
|
15
|
+
"access": "public"
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"dist",
|
|
19
|
+
"LICENSE",
|
|
20
|
+
"package.json",
|
|
21
|
+
"README.md",
|
|
22
|
+
"CHANGELOG.md"
|
|
23
|
+
],
|
|
24
|
+
"keywords": [],
|
|
25
|
+
"author": "geekact",
|
|
26
|
+
"license": "MIT",
|
|
27
|
+
"peerDependencies": {
|
|
28
|
+
"@aomex/console": "^0.0.0",
|
|
29
|
+
"@aomex/core": "^0.0.0",
|
|
30
|
+
"@aomex/web": "^0.0.0",
|
|
31
|
+
"@aomex/web-router": "^0.0.0"
|
|
32
|
+
},
|
|
33
|
+
"dependencies": {
|
|
34
|
+
"@aomex/file-parser": "^0.0.0",
|
|
35
|
+
"@aomex/helper": "^0.0.0",
|
|
36
|
+
"filesize": "^10.0.6",
|
|
37
|
+
"ibm-openapi-validator": "^0.97.3",
|
|
38
|
+
"ora": "^6.1.2",
|
|
39
|
+
"read-pkg-up": "^9.1.0",
|
|
40
|
+
"yaml": "^2.2.1"
|
|
41
|
+
},
|
|
42
|
+
"devDependencies": {
|
|
43
|
+
"@aomex/console": "^0.0.0",
|
|
44
|
+
"@aomex/core": "^0.0.0",
|
|
45
|
+
"@aomex/web": "^0.0.0",
|
|
46
|
+
"@aomex/web-router": "^0.0.0",
|
|
47
|
+
"@types/ibm-openapi-validator": "^0.15.1"
|
|
48
|
+
},
|
|
49
|
+
"scripts": {}
|
|
50
|
+
}
|