@wx-sab/renkei 0.2.7

package/README.md

@@ -0,0 +1,194 @@
+# @wx-sab/renkei
+
+解析 swagger 转为 ts 代码，生成可立即使用的 ts 代码，无需手动书写接口定义
+
+> 日本动漫《游戏王》中的‘Renkei’，意为连携或协作。
+
+## Feature
+
+- [x] 支持 `swagger` 解析
+- [x] 支持 `apifox` 导出 `swagger` 解析
+- [x] 支持多项目/多服务配置
+- [x] 支持远程 `apifox` 远程 Mock
+- [x] 多服务的 apifox 项目解析
+- [x] 支持 swagger 3.0 解析
+
+## Introduce
+
+### Install
+
+项目发布在私有的 `npm源`，故需要更改 npm 源地址为：[http://10.10.200.19:4873/](http://10.10.200.19:4873/)(临时的)
+
+```bash
+  npm install @wx-sab/renkei --registry http://10.10.200.19:4873
+```
+
+> 注：可以使用 nrm 管理 npm 源
+
+### Configuration
+
+```ts
+import { GenerateApiParams, RawRouteInfo } from "swagger-typescript-api";
+
+/**
+ * 基础配置
+ */
+export type BasicConfig = {
+  /**
+   * 内置接口文档来源
+   * swagger: `http://10.101.16.30:31809/${server}/v2/api-docs`
+   * apifox: `http://127.0.0.1:4523/export/openapi?projectId=${projectId}&version=2.0`
+   */
+  sourceType?: "swagger" | "apifox";
+  /**
+   * 自定义接口文档来源，与 sourceType 互斥，优先级比 sourceType 高
+   */
+  source?: string;
+  /**
+   * 声明文件输出目录, 默认 src/services
+   */
+  output?: string;
+  /**
+   * 配置文件url, 默认读取项目根目录下的 renkei.config.js 或者 renkei.config.ts
+   */
+  configUrl?: string;
+  /**
+   * 数据模型的命名空间
+   */
+  modelNamespace?: string;
+  /**
+   * 接口服务名
+   */
+  serviceName: string;
+  /**
+   * 可以生成多个项目，会继承父配置项
+   */
+  projects?: GenerateConfig[];
+  /**
+   * 自定义 request 引入模板
+   * 默认：import request from '${pkg.name}/lib/request'
+   */
+  requestTempalte?: string;
+  /**
+   * 自定义响应类型，默认为 AxiosResponse<T>
+   */
+  customResponseType?(type: string): string;
+  /**
+   * 自定义组装请求的url
+   * 自定义组装 mock 的url
+   */
+  customRequestUrl?(routeData: RawRouteInfo): string | {
+    /**
+     * 接口请求路径
+     */
+    path: string;
+    /**
+     * mock请求完整 url
+     */
+    mockUrl?: string
+  };
+}
+/**
+ * 如果 sourceType 是 apifox，则适用该配置项
+ */
+export type ApifoxConfig = {
+  /**
+   * apifox 项目ID
+   */
+  apifoxProjectId?: string;
+  /**
+   * 自定义 mock 服务地址
+   */
+  customMockService?(config: GenerateConfig): string
+};
+
+/**
+ * 配置项
+ */
+export type GenerateConfig = Partial<GenerateApiParams> &
+  BasicConfig & ApifoxConfig;
+
+```
+
+### Useage
+
+```ts
+import { defineConfig } from "@wx-sab/renkei";
+
+export default defineConfig([
+  // apifox 单服务项目
+  {
+    // 服务名
+    serviceName: "dp-order",
+    // 项目ID
+    apifoxProjectId: "2963311",
+  },
+  // apifox 多服务项目
+  {
+    // 服务名
+    serviceName: "dp-service",
+    // 项目ID
+    apifoxProjectId: "2954843",
+    // 自定义 request 引入
+    requestTempalte: `import { request } from '@/utils/http'`,
+    // 自定义组装请求url
+    customRequestUrl: (routeData) => {
+      return (
+        "/" +
+        // @ts-ignore
+        routeData["x-apifox-folder"].split("/")[0] +
+        // @ts-ignore
+        routeData.route
+      );
+    },
+  },
+  // swagger项目
+  {
+    sourceType: 'swagger',
+    serviceName: 'dp-product',
+  },
+  // 自定义 swagger 源
+  {
+    source: 'https://swagger.com/xxx/xxx',
+    serviceName: 'custom-swagger'
+  }
+]);
+```
+
+## Examples
+
+### 自定义接口的 mock 服务
+```ts
+import { request } from '@/utils/request'
+import { DpService } from './services/dp-service'
+
+const mockProxy = {
+  "/dp-order": {
+    mockService: "https://mock.apifox.cn/m1/2954843-0-6f0df579",
+  },
+  "/dp-product": {
+    mockService: "https://mock.apifox.cn/m1/2954843-0-4d5b1ae0",
+  },
+};
+
+generateApis({
+  // 服务名
+  serviceName: "dp-service",
+  // 项目ID
+  apifoxProjectId: "2954843",
+  // 自定义 request 引入
+  requestTempalte: `import request from "../../core/request";`,
+  // 自定义组装请求url
+  customRequestUrl: (routeData) => {
+    const prefix = "/" + routeData["x-apifox-folder"].split("/")[0];
+    const path = prefix + routeData.route;
+
+    return {
+      path,
+      // @ts-ignore
+      mockUrl: mockProxy[prefix]?.mockService ? mockProxy[prefix]?.mockService + routeData.route : undefined,
+    };
+  },
+});
+
+```

package/lib/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/cli.js

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = __importDefault(require("commander"));
+const TSNode = __importStar(require("ts-node"));
+const api_1 = __importDefault(require("./commands/api"));
+TSNode.register({
+    // 不加载本地的 tsconfig.json
+    skipProject: true,
+    // 仅转译，不做类型检查
+    transpileOnly: true,
+    // 自定义编译选项
+    compilerOptions: {
+        strict: false,
+        target: "es6",
+        module: "commonjs",
+        moduleResolution: "node",
+        declaration: false,
+        removeComments: false,
+        esModuleInterop: true,
+        allowSyntheticDefaultImports: true,
+        importHelpers: false,
+        allowJs: true,
+        lib: ["esnext"],
+    },
+});
+commander_1.default.program
+    .version(require("../package.json").version, "-v, --version")
+    .addCommand(api_1.default)
+    .parse();

package/lib/commands/api.d.ts

@@ -0,0 +1,3 @@
+import commander from 'commander';
+declare const parse: commander.Command;
+export default parse;

package/lib/commands/api.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const commander_1 = __importDefault(require("commander"));
+const generate_1 = require("../core/generate");
+const constants_1 = require("../core/constants");
+/**
+ * 读取项目中的配置文件
+ */
+const readProjectConfigFile = () => {
+    for (const file of constants_1.CONFIG_FILE_NAMES) {
+        const fullFilePath = path_1.default.resolve(process.cwd(), file);
+        if (fs_1.default.existsSync(fullFilePath)) {
+            if (fullFilePath.endsWith('.ts')) {
+                return require(fullFilePath).default;
+            }
+            return require(fullFilePath);
+        }
+    }
+    return null;
+};
+const parse = new commander_1.default.Command('api').action(() => {
+    const config = readProjectConfigFile();
+    if (!config) {
+        console.warn('未找到配置文件');
+        return;
+    }
+    (0, generate_1.generateApis)(config);
+});
+exports.default = parse;

package/lib/core/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const CONFIG_FILE_NAMES: string[];
+export declare const DOC_SOURCE_SWAGGER: (server: string) => string;
+export declare const DOC_SOURCE_APIFOX: (projectId: string) => string;
+export declare const MOCK_SERVICE_APIFOX: (projectId: string) => string;

package/lib/core/constants.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MOCK_SERVICE_APIFOX = exports.DOC_SOURCE_APIFOX = exports.DOC_SOURCE_SWAGGER = exports.CONFIG_FILE_NAMES = void 0;
+// 读取项目的配置文件名
+exports.CONFIG_FILE_NAMES = ['renkei.config.js', 'renkei.config.ts'];
+// 内置 swagger 文档源
+const DOC_SOURCE_SWAGGER = (server) => `http://10.101.16.30:30600/${server}/v2/api-docs`;
+exports.DOC_SOURCE_SWAGGER = DOC_SOURCE_SWAGGER;
+// 内置 apifox 文档源
+const DOC_SOURCE_APIFOX = (projectId) => `http://127.0.0.1:4523/export/openapi?projectId=${projectId}&version=2.0`;
+exports.DOC_SOURCE_APIFOX = DOC_SOURCE_APIFOX;
+// 内置 apifox mock 服务
+const MOCK_SERVICE_APIFOX = (projectId) => `https://mock.apifox.cn/m1/${projectId}-0-default`;
+exports.MOCK_SERVICE_APIFOX = MOCK_SERVICE_APIFOX;

package/lib/core/generate.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 生成接口模型和请求
+ */
+import { GenerateConfig } from "./interface";
+/**
+ * 单个配置生成
+ */
+export declare const generate: (conf: GenerateConfig) => Promise<import("swagger-typescript-api").GenerateApiOutput>;
+export declare const generateApis: (config: GenerateConfig | GenerateConfig[]) => Promise<void>;

package/lib/core/generate.js

@@ -0,0 +1,149 @@
+"use strict";
+/**
+ * 生成接口模型和请求
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateApis = exports.generate = void 0;
+const path_1 = __importDefault(require("path"));
+const lodash_1 = __importDefault(require("lodash"));
+const swagger_typescript_api_1 = require("swagger-typescript-api");
+const utils_1 = require("./utils");
+/**
+ * 单个配置生成
+ */
+const generate = (conf) => {
+    // 最终使用的配置项
+    const config = (0, utils_1.generateConfig)(conf);
+    // 模型命名空间
+    const modelNamespace = lodash_1.default.upperFirst(lodash_1.default.camelCase(config.modelNamespace));
+    // 服务名
+    const serviceName = lodash_1.default.upperFirst(lodash_1.default.camelCase(config.serviceName));
+    // 存放已生成的方法名
+    const methodNameSet = new Set();
+    return (0, swagger_typescript_api_1.generateApi)({
+        url: config.source,
+        // 文件名
+        name: config.name,
+        // 输出目录
+        output: path_1.default.resolve(config.output, config.serviceName),
+        // 模块化？
+        modular: false,
+        extractRequestParams: true,
+        // 清空输出目录？
+        cleanOutput: false,
+        // 生成请求客户端
+        generateClient: false,
+        // 模板文件
+        templates: path_1.default.resolve(__dirname, "../../templates"),
+        // 额外的，此处为了生成接口
+        extraTemplates: [
+            {
+                name: "index.ts",
+                path: path_1.default.resolve(__dirname, "../../templates/service.ejs"),
+            },
+        ],
+        hooks: {
+            onCreateRouteName(routeNameInfo, rawRouteInfo) {
+                var _a;
+                // 自定义请求路由
+                const newRoute = (_a = config.customRequestUrl) === null || _a === void 0 ? void 0 : _a.call(config, rawRouteInfo);
+                if (typeof newRoute === "string") {
+                    rawRouteInfo.route = newRoute;
+                }
+                else if (newRoute === null || newRoute === void 0 ? void 0 : newRoute.path) {
+                    rawRouteInfo.route = newRoute.path;
+                    // @ts-ignore
+                    rawRouteInfo.mockUrl = newRoute.mockUrl;
+                }
+                const methodName = (0, utils_1.generateRouteName)(rawRouteInfo.method, rawRouteInfo.route);
+                const duplicate = methodNameSet.has(methodName);
+                methodNameSet.add(methodName);
+                return {
+                    duplicate: duplicate,
+                    original: methodName,
+                    usage: methodName,
+                };
+            },
+            onPrepareConfig(currentConfiguration) {
+                return Object.assign(Object.assign({}, currentConfiguration), { modelNamespace,
+                    serviceName, requestTempalte: config.requestTempalte });
+            },
+            onParseSchema(originalSchema, parsedSchema) {
+                // 针对解析出的 any 做转换，主要是 swagger 3.0
+                if (parsedSchema.name === "any" &&
+                    typeof parsedSchema.content === "string" &&
+                    parsedSchema.$ref) {
+                    return Object.assign(Object.assign({}, parsedSchema), { content: `${modelNamespace}.${serviceName}.${(0, utils_1.getValidName)(decodeURIComponent(parsedSchema.$ref))}` });
+                }
+                return parsedSchema;
+            },
+            onCreateRoute(routeData) {
+                var _a;
+                // 将 /api/v1/order-mains/{orderId} 转成 /api/v1/order-mains/${orderId}
+                // routeData.raw.route 是进过 customRequestUrl 转换过的
+                // @ts-ignore
+                routeData.request.path = (_a = routeData.raw.route) === null || _a === void 0 ? void 0 : _a.replace(/\{([^}]+)\}/g, '${$1}');
+                return routeData;
+            },
+            onInit(configuration) {
+                return Object.assign(Object.assign({}, configuration), { serviceName: config.serviceName, apifoxProjectId: config.apifoxProjectId, customResponseType: config.customResponseType, customMockService: config.customMockService });
+            },
+        },
+    });
+};
+exports.generate = generate;
+// 批量生成接口
+const generateApis = (config) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, e_1, _b, _c;
+    // 递归收集config下可能有的 projects ，也当做新的config
+    const collectConfig = (conf, collects = []) => {
+        if (!conf)
+            return collects;
+        if (Array.isArray(conf)) {
+            conf.forEach((con) => collectConfig(con, collects));
+        }
+        else if (Array.isArray(conf.projects)) {
+            conf.projects.forEach((project) => collectConfig(Object.assign(Object.assign({}, conf), project), collects));
+        }
+        else {
+            collects.push(conf);
+        }
+        return collects;
+    };
+    const _configs = collectConfig(config);
+    try {
+        for (var _d = true, _configs_1 = __asyncValues(_configs), _configs_1_1; _configs_1_1 = yield _configs_1.next(), _a = _configs_1_1.done, !_a; _d = true) {
+            _c = _configs_1_1.value;
+            _d = false;
+            const conf = _c;
+            yield (0, exports.generate)(conf);
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (!_d && !_a && (_b = _configs_1.return)) yield _b.call(_configs_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+});
+exports.generateApis = generateApis;

package/lib/core/interface.d.ts

@@ -0,0 +1,76 @@
+import { GenerateApiParams, RawRouteInfo } from "swagger-typescript-api";
+/**
+ * 基础配置
+ */
+export type BasicConfig = {
+    /**
+     * 内置接口文档来源
+     * swagger: `http://10.101.16.30:31809/${server}/v2/api-docs`
+     * apifox: `http://127.0.0.1:4523/export/openapi?projectId=${projectId}&version=2.0`
+     */
+    sourceType?: "swagger" | "apifox";
+    /**
+     * 自定义接口文档来源，与 sourceType 互斥，优先级比 sourceType 高
+     */
+    source?: string;
+    /**
+     * 声明文件输出目录, 默认 src/services
+     */
+    output?: string;
+    /**
+     * 配置文件url, 默认读取项目根目录下的 renkei.config.js 或者 renkei.config.ts
+     */
+    configUrl?: string;
+    /**
+     * 数据模型的命名空间
+     */
+    modelNamespace?: string;
+    /**
+     * 接口服务名
+     */
+    serviceName: string;
+    /**
+     * 可以生成多个项目，会继承父配置项
+     */
+    projects?: GenerateConfig[];
+    /**
+     * 自定义 request 引入模板
+     * 默认：import request from '${pkg.name}/lib/request'
+     */
+    requestTempalte?: string;
+    /**
+     * 自定义响应类型，默认为 AxiosResponse<T>
+     */
+    customResponseType?(type: string): string;
+    /**
+     * 自定义组装请求的url
+     * 自定义组装 mock 的url
+     */
+    customRequestUrl?(routeData: RawRouteInfo): string | {
+        /**
+         * 接口请求路径
+         */
+        path: string;
+        /**
+         * mock请求完整 url
+         */
+        mockUrl?: string;
+    };
+};
+/**
+ * 如果 sourceType 是 apifox，则适用该配置项
+ */
+export type ApifoxConfig = {
+    /**
+     * apifox 项目ID
+     */
+    apifoxProjectId?: string;
+    /**
+     * 自定义 mock 服务地址
+     */
+    customMockService?(config: GenerateConfig): string;
+};
+/**
+ * 配置项
+ */
+export type GenerateConfig = Partial<GenerateApiParams> & BasicConfig & ApifoxConfig;

package/lib/core/interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/core/request.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("axios").AxiosInstance;
+export default _default;

package/lib/core/request.js

@@ -0,0 +1,7 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+exports.default = axios_1.default.create();

package/lib/core/utils.d.ts

@@ -0,0 +1,21 @@
+import { GenerateConfig } from "./interface";
+/**
+ * 生成最终使用的配置参数
+ */
+export declare const generateConfig: (conf: Partial<GenerateConfig>) => Partial<GenerateConfig>;
+/**
+ * 生成方法名
+ */
+export declare const generateRouteName: (method: string, route: string) => string;
+/**
+ * 辅助配置文件
+ * @param configs
+ * @returns
+ */
+export declare const defineConfig: (configs: GenerateConfig | GenerateConfig[]) => GenerateConfig | GenerateConfig[];
+/**
+ * 过滤嵌套情况 ResponseVO«AgentTraceVO»
+ * @param content
+ * @returns
+ */
+export declare function getValidName(content: string): string;

package/lib/core/utils.js

@@ -0,0 +1,89 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getValidName = exports.defineConfig = exports.generateRouteName = exports.generateConfig = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const path_1 = __importDefault(require("path"));
+const constants_1 = require("./constants");
+/**
+ * 生成最终使用的配置参数
+ */
+const generateConfig = (conf) => {
+    const DEFAULT_CONFIG = {
+        // 默认从 apifox 生成
+        sourceType: 'apifox',
+        // 默认为项目根目录下 src/services
+        output: path_1.default.resolve(process.cwd(), "./src/services"),
+        // 生成的文件名
+        name: "model.d.ts",
+        // 模块化？
+        modular: false,
+        // 数据模型 命名空间
+        modelNamespace: 'Model',
+        // 默认引入 request 模板
+        requestTempalte: `import { request } from '@wx-sab/renkei'`,
+        // 自定义响应类型
+        customResponseType: type => `AxiosResponse<${type}>`,
+        // 自定义mock服务
+        customMockService: config => config.apifoxProjectId ? (0, constants_1.MOCK_SERVICE_APIFOX)(config.apifoxProjectId) : ''
+    };
+    const finalConfig = lodash_1.default.merge(DEFAULT_CONFIG, conf);
+    // 内置文档源
+    if (!finalConfig.source) {
+        // apifox 来源
+        if (finalConfig.sourceType === 'apifox') {
+            finalConfig.source = (0, constants_1.DOC_SOURCE_APIFOX)(finalConfig.apifoxProjectId);
+        }
+        // swagger 来源
+        else if (finalConfig.sourceType === 'swagger') {
+            finalConfig.source = (0, constants_1.DOC_SOURCE_SWAGGER)(finalConfig.serviceName);
+        }
+    }
+    return finalConfig;
+};
+exports.generateConfig = generateConfig;
+/**
+ * 生成方法名
+ */
+const generateRouteName = (method, route) => {
+    return [
+        method.toLowerCase(),
+        ...route
+            .split("/")
+            // 全部转成小写
+            .map((path) => path.toLowerCase())
+            // 转义 url 中的变量， {variable} -> $p
+            .map((path) => path.replace(/^\{(.+)\}$/, "$p"))
+            // 中横线转成下划线
+            .map((path) => path.replace(/[-*.]/g, "_"))
+            .filter(Boolean),
+    ].join("_");
+};
+exports.generateRouteName = generateRouteName;
+/**
+ * 辅助配置文件
+ * @param configs
+ * @returns
+ */
+const defineConfig = (configs) => {
+    return configs;
+};
+exports.defineConfig = defineConfig;
+/**
+ * 过滤嵌套情况 ResponseVO«AgentTraceVO»
+ * @param content
+ * @returns
+ */
+function getValidName(content) {
+    if (!content)
+        return null;
+    if (content.match(/\W/)) {
+        const contents = content.split("/");
+        const last = contents[contents.length - 1];
+        return last.replace(/\W/g, "");
+    }
+    return content;
+}
+exports.getValidName = getValidName;

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+import { generateApis } from "./core/generate";
+import { defineConfig } from "./core/utils";
+import request from "./core/request";
+export { GenerateConfig } from "./core/interface";
+export { generateApis, request, defineConfig };

package/lib/index.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineConfig = exports.request = exports.generateApis = void 0;
+const generate_1 = require("./core/generate");
+Object.defineProperty(exports, "generateApis", { enumerable: true, get: function () { return generate_1.generateApis; } });
+const utils_1 = require("./core/utils");
+Object.defineProperty(exports, "defineConfig", { enumerable: true, get: function () { return utils_1.defineConfig; } });
+const request_1 = __importDefault(require("./core/request"));
+exports.request = request_1.default;

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@wx-sab/renkei",
+  "version": "0.2.7",
+  "description": "解析swagger转为ts代码，日本动漫《游戏王》中的‘Renkei’，意为连携或协作。",
+  "main": "./lib/index.js",
+  "bin": {
+    "renkei": "./lib/cli.js"
+  },
+  "scripts": {
+    "dev": "ts-node ./src/index.ts",
+    "demo": "ts-node ./demo.ts",
+    "clean": "rm -rf lib",
+    "build": "npm run clean & tsc --outDir lib"
+  },
+  "repository": {
+    "type": "git",
+    "url": "http://10.10.255.105/fe/api-to-ts.git"
+  },
+  "author": "sab-fe",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/lodash": "^4.14.196",
+    "@types/node": "^20.4.7",
+    "typescript": "^5.1.6"
+  },
+  "files": [
+    "lib",
+    "templates"
+  ],
+  "dependencies": {
+    "axios": "^1.4.0",
+    "commander": "^11.0.0",
+    "lodash": "^4.17.21",
+    "swagger-typescript-api": "^12.0.4",
+    "ts-node": "^10.9.1"
+  }
+}

package/templates/api.ejs

@@ -0,0 +1,102 @@
+<%
+const { apiConfig, routes, utils, config, requestTemplate, modelNamespace, serviceName, namespace, requestTempalte, modelTypes } = it;
+const { info, servers, externalDocs } = apiConfig;
+const { _, require, formatDescription } = utils;
+
+const server = (servers && servers[0]) || { url: "" };
+
+const descriptionLines = _.compact([
+  `@title ${info.title || "No title"}`,
+  info.version && `@version ${info.version}`,
+  info.license && `@license ${_.compact([
+    info.license.name,
+    info.license.url && `(${info.license.url})`,
+  ]).join(" ")}`,
+  info.termsOfService && `@termsOfService ${info.termsOfService}`,
+  server.url && `@baseUrl ${server.url}`,
+  externalDocs.url && `@externalDocs ${externalDocs.url}`,
+  info.contact && `@contact ${_.compact([
+    info.contact.name,
+    info.contact.email && `<${info.contact.email}>`,
+    info.contact.url && `(${info.contact.url})`,
+  ]).join(" ")}`,
+  info.description && " ",
+  info.description && _.replace(formatDescription(info.description), /\n/g, "\n * "),
+]);
+
+%>
+
+// @ts-nocheck
+
+<% if (descriptionLines.length) { %>
+/**
+<% descriptionLines.forEach((descriptionLine) => { %>
+* <%~ descriptionLine %>
+
+<% }) %>
+*/
+<% } %>
+
+import { AxiosResponse, AxiosRequestConfig } from 'axios'
+import type { <%~ modelNamespace %> } from './model.d.ts'
+
+// 自定义 request 模板
+<%~ requestTempalte %>
+
+type RequestConfig = AxiosRequestConfig & {
+  /**
+   * 开启mock
+   */
+  mock?: boolean;
+}
+
+enum ContentType {
+  Json = 'application/json',
+  FormData = 'multipart/form-data',
+  UrlEncoded = 'application/x-www-form-urlencoded',
+}
+
+export class <%~ serviceName %> {
+  /**
+   * 常规 Mock 服务地址
+   */
+  static private mockService = '<%~ config.customMockService?.(config) || '' %>';
+  static setMockService (service) {
+    <%~ serviceName %>.mockService = service;
+  }
+
+  /**
+   * 开启Mock
+   */
+  static private isMock = false;
+  static enableMock(enable?: boolean = true) {
+    <%~ serviceName %>.isMock = enable;
+  }
+
+  /**
+   * 如果开启 mock, 替换请求的url
+   * @param {String} path 请求接口路径
+   * @param {Boolean} mock 是否开启 Mock
+   * @param {String} customMockUrl 自定义mock链接
+   */
+  static generateUrl(params: {
+    path: string,
+    mock?: boolean,
+    customMockUrl?: string
+  }): string {
+    if (<%~ serviceName %>.isMock || params.mock) {
+      return params.customMockUrl || (<%~ serviceName %>.mockService + params.path)
+    }
+    return params.path;
+  }
+
+  <% routes.combined && routes.combined.forEach(({ routes = [], moduleName }) => { %>
+    <% routes.forEach((route) => { %>
+
+        <%~ includeFile('./procedure-call.eta', { ...it, route }) %>
+
+    <% }) %>
+  <% }) %>
+}
+
+export { <%~ modelNamespace %> }

package/templates/data-contracts.ejs

@@ -0,0 +1,54 @@
+<%
+  const { modelTypes, utils, config, namespace, modelNamespace, serviceName } = it;
+  const { enumRefs } = config
+  const { formatDescription, require, _ } = utils;
+
+
+  const dataContractTemplates = {
+    enum: (contract) => {
+      if (contract.typeData.relativePath) {
+        return `type ${contract.name} = ${contract.typeData.uniqueName};`;
+      }
+      return `enum ${contract.name} {\r\n${contract.content} \r\n }`;
+    },
+    interface: (contract) => {
+      return `interface ${contract.name} {\r\n${contract.content}}`;
+    },
+    type: (contract) => {
+      return `type ${contract.name} = ${contract.content}`;
+    },
+  }
+
+  const createDescription = (contract) => {
+    if (!contract.typeData) return _.compact([contract.description]);
+
+    return _.compact([
+        contract.description && formatDescription(contract.description),
+        !_.isUndefined(contract.typeData.format) && `@format ${contract.typeData.format}`,
+        !_.isUndefined(contract.typeData.minimum) && `@min ${contract.typeData.minimum}`,
+        !_.isUndefined(contract.typeData.maximum) && `@max ${contract.typeData.maximum}`,
+        !_.isUndefined(contract.typeData.pattern) && `@pattern ${contract.typeData.pattern}`,
+        !_.isUndefined(contract.typeData.example) && `@example ${
+          _.isObject(contract.typeData.example) ? JSON.stringify(contract.typeData.example) : contract.typeData.example
+        }`,
+    ]);
+  }
+%>
+
+export namespace <%~ modelNamespace %> {
+  export namespace <%~ serviceName %> {
+    <% modelTypes.forEach((contract) => { %>
+      <% const description = createDescription(contract); %>
+
+      <% if (description.length) { %>
+        /**
+        <%~ description.map(part => `* ${part}`).join("\n") %>
+
+        */
+      <% } %>
+      <%~ (dataContractTemplates[contract.typeIdentifier] || dataContractTemplates.type)(contract) %>
+
+    <% }) %>
+  }
+}
+

package/templates/procedure-call.ejs

@@ -0,0 +1,172 @@
+<%
+const { utils, route, config, modelTypes, namespace, modelNamespace, serviceName, requestTempalte, rawModelTypes, strict, } = it;
+const { requestBodyInfo, responseBodyInfo, specificArgNameResolver, routeParams, conflict, merged } = route;
+const { _, getInlineParseContent, getParseContent, parseSchema, getComponentByRef, require, pick } = utils;
+const { parameters, path, method, payload, query, formData, security, requestParams } = route.request;
+const { type, errorType, contentTypes } = route.response;
+const { HTTP_CLIENT, RESERVED_REQ_PARAMS_ARG_NAMES } = config.constants;
+const routeDocs = includeFile("@custom/route-docs", { config, route, utils });
+const queryName = (query && query.name) || "query";
+const pathParams = _.values(parameters);
+const pathParamsNames = _.map(pathParams, "name");
+
+const isFetchTemplate = config.httpClientType === HTTP_CLIENT.FETCH;
+
+const requestConfigParam = {
+    name: 'config',
+    optional: true,
+    type: "RequestConfig",
+    defaultValue: "{}",
+}
+
+const getListItemType = (type) => type.replace(/\((\w+)\)\[\]/g, (match, key) => `${key}[]`)
+
+const getFullType = (type) => {
+    const matchType = modelTypes.find(t => (t.name || t.type) === type)
+    if (!matchType) {
+        return type
+    }
+
+    return `${modelNamespace}.${serviceName}.${type}`
+}
+
+const getWrapperFullType = (type) => {
+    const fullType = getFullType(type)
+    const wrapper = config.customResponseType?.(fullType)
+    if (wrapper) {
+        return wrapper
+    }
+    return fullType
+}
+
+const argToTmpl = ({ name, optional, type, defaultValue }) => `${name}${!defaultValue && optional ? '?' : ''}: ${getFullType(type)}${defaultValue ? ` = ${defaultValue}` : ''}`;
+
+const rawWrapperArgs = config.extractRequestParams ?
+    _.compact([
+        requestParams && {
+            name: pathParams.length ? `{ ${_.join(pathParamsNames, ", ")}, ...${queryName} }` : queryName,
+            optional: false,
+            type: getInlineParseContent(requestParams),
+        },
+        ...(!requestParams ? pathParams : []),
+        payload,
+        requestConfigParam,
+    ]) :
+    _.compact([
+        ...pathParams,
+        query,
+        payload,
+        requestConfigParam,
+    ])
+
+const wrapperArgs = _
+    // Sort by optionality
+    .sortBy(rawWrapperArgs, [o => o.optional])
+    .map(argToTmpl)
+    .join(', ')
+
+// RequestParams["type"]
+const requestContentKind = {
+    "JSON": "ContentType.Json",
+    "URL_ENCODED": "ContentType.UrlEncoded",
+    "FORM_DATA": "ContentType.FormData",
+}
+
+// RequestParams["format"]
+const responseContentKind = {
+    "JSON": '"json"',
+    "IMAGE": '"blob"',
+    "FORM_DATA": isFetchTemplate ? '"formData"' : '"document"'
+}
+
+const bodyTmpl = _.get(payload, "name") || null;
+const queryTmpl = (query != null && queryName) || null;
+const bodyContentKindTmpl = requestContentKind[requestBodyInfo.contentKind] || null;
+const responseFormatTmpl = responseContentKind[responseBodyInfo.success && responseBodyInfo.success.schema && responseBodyInfo.success.schema.contentKind] || null;
+const securityTmpl = security ? 'true' : null;
+
+const describeReturnType = () => {
+    if (!config.toJS) return "";
+
+    switch(config.httpClientType) {
+        case HTTP_CLIENT.AXIOS: {
+            return `Promise<AxiosResponse<${type}>>`
+        }
+        default: {
+            return `Promise<HttpResponse<${type}, ${errorType}>`
+        }
+    }
+}
+
+const mergeInlineType = (schemas) => {
+    if (!schemas?.length) return null
+    const mergedType = schemas.reduce((acc, cur) => {
+        acc += `${cur.name}: ${cur.type};`
+        return acc
+    }, "")
+
+    return `{${mergedType}}`
+}
+
+const dataTypes = [
+    requestParams && getInlineParseContent(requestParams),
+    mergeInlineType(!requestParams ? pathParams : []),
+    payload?.type,
+].filter(Boolean)
+
+const dataArgs = [
+    {
+        // name: 'data',
+        name: pathParams.length ? `{ ${_.join(pathParamsNames, ", ")}, ...${queryName} }` : 'data',
+        type: dataTypes.map(getFullType).join(' & '),
+        optional: false,
+    },
+    requestConfigParam,
+].filter((item) => item.type)
+
+const wrappedDataArgs = _
+    .sortBy(dataArgs, [o => o.optional])
+    .map(argToTmpl)
+    .join(', ')
+
+const getTypeSchema = (type) => {
+    // Model.SalesService.IdParam => IdParam
+    const realType = (type || '').split('.').pop()
+    return rawModelTypes.find((item) => item.typeName === realType)?.rawTypeData?.properties
+}
+
+const requestBodySchemaNames = Object.keys(getTypeSchema(requestBodyInfo?.type) || {}).map((name) => ({ name }))
+
+%>
+
+/**
+<%~ routeDocs.description %>
+
+ * <% /* Here you can add some other JSDoc tags */ %>
+
+<%~ routeDocs.lines %>
+
+<% if(merged) { %>
+ * @merged
+<% } %>
+<% if(conflict) { %>
+ * @conflict
+<% } %>
+ */
+static public <%~ route.routeName.usage %> = async (<%~ wrappedDataArgs %>): Promise<<%~ getWrapperFullType(type) %>> => {
+    const url = <%~ serviceName %>.generateUrl({
+        path: `<%~ path %>`, 
+        mock: config.mock,
+        customMockUrl: `<%~ route.raw.mockUrl || '' %>`
+    })
+    return request({
+        url,
+        method: '<%~ _.upperCase(method) %>',
+        <%~ queryTmpl ? `params: data,` : '' %>
+        <%~ bodyTmpl ? `data,` : '' %>
+        <%~ securityTmpl ? `secure: ${securityTmpl},` : '' %>
+        <%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
+        <%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
+        ...<%~ _.get(requestConfigParam, "name") %>,
+    });
+}

package/templates/route-docs.ejs

@@ -0,0 +1,31 @@
+<%
+const { config, route, utils } = it;
+const { _, formatDescription, fmtToJSDocLine, classNameCase, require } = utils;
+const { raw, request, routeName } = route;
+
+const jsDocDescription = raw.description ?
+    ` * @description ${formatDescription(raw.description, true)}` :
+    fmtToJSDocLine('No description', { eol: false });
+const jsDocLines = _.compact([
+    _.size(raw.tags) && ` * @tags ${raw.tags.join(", ")}`,
+    ` * @name ${classNameCase(routeName.usage)}`,
+    raw.summary && ` * @summary ${raw.summary}`,
+    ` * @request ${_.upperCase(request.method)}:${raw.route}`,
+    raw.deprecated && ` * @deprecated`,
+    routeName.duplicate && ` * @originalName ${routeName.original}`,
+    routeName.duplicate && ` * @duplicate`,
+    request.security && ` * @secure`,
+    ...(config.generateResponses && raw.responsesTypes.length
+    ? raw.responsesTypes.map(
+        ({ type, status, description, isSuccess }) =>
+            ` * @response \`${status}\` \`${type}\` ${description}`,
+        )
+    : []),
+]).join("\n");
+
+
+return {
+  description: jsDocDescription,
+  lines: jsDocLines,
+}
+%>

package/templates/service.ejs

@@ -0,0 +1,34 @@
+<%
+  const { modelTypes, utils, config, namespace, serviceName } = it;
+  const { formatDescription, require, _ } = utils;
+
+
+  const dataContractTemplates = {
+    enum: (contract) => {
+      return `enum ${contract.name} {\r\n${contract.content} \r\n }`;
+    },
+    interface: (contract) => {
+      return `interface ${contract.name} {\r\n${contract.content}}`;
+    },
+    type: (contract) => {
+      return `type ${contract.name} = ${contract.content}`;
+    },
+  }
+
+  const createDescription = (contract) => {
+    if (!contract.typeData) return _.compact([contract.description]);
+
+    return _.compact([
+        contract.description && formatDescription(contract.description),
+        !_.isUndefined(contract.typeData.format) && `@format ${contract.typeData.format}`,
+        !_.isUndefined(contract.typeData.minimum) && `@min ${contract.typeData.minimum}`,
+        !_.isUndefined(contract.typeData.maximum) && `@max ${contract.typeData.maximum}`,
+        !_.isUndefined(contract.typeData.pattern) && `@pattern ${contract.typeData.pattern}`,
+        !_.isUndefined(contract.typeData.example) && `@example ${
+          _.isObject(contract.typeData.example) ? JSON.stringify(contract.typeData.example) : contract.typeData.example
+        }`,
+    ]);
+  }
+%>
+
+<%~ includeFile('./api.ejs', { ...it }) %>