openapi-ts-request 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 openapi-ui
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,147 @@
+## Introduce
+
+[![GitHub Repo stars](https://img.shields.io/github/stars/openapi-ui/openapi-ts-request?style=social)](https://github.com/openapi-ui/openapi-ts-request)
+[![npm (scoped)](https://img.shields.io/npm/v/openapi-ts-request)](https://www.npmjs.com/package/openapi-ts-request)
+![GitHub tag](https://img.shields.io/github/v/tag/openapi-ui/openapi-ts-request?include_prereleases)
+
+根据 [Swagger2/OpenAPI3](https://swagger.io/blog/news/whats-new-in-openapi-3-0/) 文档生成 ts 类型、request client 请求代码。
+
+## Features
+
+* supports Swagger2.0/OpenAPI 3.0,3.1 specifications
+* generate TypeScript Interfaces, Reuquest clients, Display Babel
+* supports Custom Request Function, Fetch、Axios、Uniapp-Request、Node.js、XHR client available
+* supports JSON specifications
+
+## Usage
+
+```bash
+npm i openapi-ts-request --save-dev
+
+pnpm i openapi-ts-request -D
+```
+
+### CosmiConfig
+
+在项目根目录新建 ```openapi-ts-request.config.ts``` 
+> 配置文件还支持 ***.openapi-ts-request.ts***, ***openapi-ts-request.config.cjs*** 等格式，参考 [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig?tab=readme-ov-file#cosmiconfig)
+
+```ts
+export default {
+  schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
+}
+```
+
+如果项目有多个生成需求，支持传入数组配置
+
+```ts
+export default [
+  {
+    schemaPath: 'http://app.swagger.io/v2/swagger.json',
+    serversPath: './src/apis/app',
+  },
+  {
+    schemaPath: 'http://auth.swagger.io/v2/swagger.json',
+    serversPath: './src/apis/auth',
+  }
+]
+```
+
+在 ```package.json``` 的 ```script``` 中添加 api: ```"openapi": "openapi-ts-request",```
+
+生成 api
+
+```bash
+npm run openapi
+```
+
+### JS
+
+任意目录 ```xxx/xxx``` 新建 ```openapi-ts-request.config.js```
+
+```ts
+const { generateService } = require('openapi-ts-request')
+
+generateService({
+  schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
+  serversPath: './apis',
+})
+```
+
+在 ```package.json``` 的 ```script``` 中添加 script: ```"openapi": "node xxx/xxx/openapi-ts-request.config.js"```
+
+生成 api
+
+```bash
+npm run openapi
+```
+
+### TS
+
+任意目录 ```xxx/xxx``` 新建 ```openapi-ts-request.config.ts```
+
+```ts
+const { generateService } = require('openapi-ts-request')
+
+generateService({
+  schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
+  serversPath: './apis',
+})
+```
+
+在 ```package.json``` 的 ```script``` 中添加 api: ```"openapi": "ts-node xxx/xxx/openapi-ts-request.config.ts",```
+
+生成 api
+```bash
+npm run openapi
+```
+
+## Parameter
+
+|  属性   | 必填  | 备注 | 类型 | 默认值 |
+|  ----  | ----  |  ----  |  ----  | - |
+| schemaPath  | 是 | Swagger 2.0 或 OpenAPI 3.0 的地址 | string | - |
+| serversPath  | 否 | 生成的文件夹的路径 | string | './src/apis' |
+| requestLibPath  | 否 | 自定义请求方法路径 | string | - |
+| allowedTags  | 否 | 生成指定 tags 下面的 api | string[] | - |
+| requestOptionsType  | 否 | 自定义请求方法 options 参数类型 | string | '{ [key: string]: any }' |
+| requestImportStatement  | 否 | 自定义请求方法表达式，例如：'@/request' | string | - |
+| apiPrefix  | 否 | api 的前缀，例如："'api'" | string | - |
+| dataFields | 否 | 定义 response 中数据字段类型 | string[] | - |
+| mockFolder  | 否 | mock目录 | string | './mocks' |
+| nullable | 否 | 使用null代替可选 | boolean | false |
+| isCamelCase | 否 | 小驼峰命名文件和请求函数 | boolean | true |
+| hook | 否 | 自定义 hook | [Custom Hook](#Custom-Hook) | - |
+
+## Custom Hook
+
+| 属性           | 类型 | 说明               |
+| -------------- | ---- | ------------------ |
+| afterOpenApiDataInited | (openAPIData: OpenAPIObject) => OpenAPIObject  | - |
+| customFunctionName | (data: APIDataType) => string   | 自定义请求方法函数名称 |
+| customTypeName | (data: APIDataType) => string | 自定义类型名称 |
+| customClassName | (tagName: string) => string  | 自定义类名 |
+| customType | (<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string) => string,<br>) => string  | 自定义获取类型 <br> *返回非字符串将使用默认方法获取type* |
+| customFileNames |  (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[]   | 自定义生成文件名，可返回多个，表示生成多个文件. <br> *返回为空，则使用默认的获取方法获取* |
+
+## Mock
+
+目前使用 [mockjs](http://mockjs.com) 生成 mock 数据，mocks 文件启动需要借助 [@umijs/server](https://umijs.org/docs/guides/mock)，后面会寻找其他方案以达到更好的 mock 体验
+
+## Thanks
+
+- [openapi2typescript](https://github.com/chenshuai2144/openapi2typescript)
+
+ps：由于 openapi2typescript 仓库作者不怎么维护这个工具，不会主动增加功能，有些激进的pr也不再合并，为了更大的自主性，也为了方便自己更好的维护此工具，所以基于此仓库重构代码并添加了很多功能（后续还会加一些对部分场景有用的功能），并附上了注释方便大家感兴趣的一起参与（都是为开源做一点贡献，应该不会被诟病吧😭😭😭），例如：
+* 支持 tags 筛选api（对 apifox 工具管理接口非常有用）
+* 支持枚举和枚举翻译
+* 改善 interface 对枚举的引用方式，对 ast 提示更友好
+* 改写 type 文件组织方式，引用 type 的提示更友好
+* 解决 type 重名问题
+* 支持配置文件方式使用，避免强制依赖 ts-node
+* 支持自定义 prettier 配置，将作用于生成后的代码
+* 替换 openapi 规范定义包：openapi3-ts => openapi-types
+* 添加 eslint、tslint 规则，优化代码
+* 添加 husky、lint-staged、commitlint 等等工程化工具
+* 优化对外提供的参数
+* 优化 npm 包依赖

package/dist/cli.d.ts

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

package/dist/cli.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const cosmiconfig_1 = require("cosmiconfig");
+const index_1 = require("./index");
+const explorerSync = (0, cosmiconfig_1.cosmiconfigSync)('openapi-ts-request');
+const config = (_a = explorerSync.search()) === null || _a === void 0 ? void 0 : _a.config;
+function run() {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        try {
+            if (config) {
+                const configs = Array.isArray(config)
+                    ? config
+                    : [config];
+                for (const config of configs) {
+                    yield (0, index_1.generateService)(config);
+                }
+            }
+            else {
+                throw new Error('config is not found');
+            }
+        }
+        catch (error) {
+            console.log(chalk_1.default.red(error));
+        }
+    });
+}
+void run();

package/dist/generator/config.d.ts

@@ -0,0 +1,29 @@
+import { Dictionary } from 'lodash';
+import { ParameterObject, SchemaObject } from '../type';
+export declare const serviceEntryFileName = "index";
+export declare const interfaceFileName = "types";
+export declare const displayEnumLabelFileName = "displayEnumLabel";
+export declare enum TypescriptFileType {
+    interface = "interface",
+    serviceController = "serviceController",
+    serviceIndex = "serviceIndex",
+    displayEnumLabel = "displayEnumLabel"
+}
+export declare const DEFAULT_SCHEMA: SchemaObject;
+export declare const DEFAULT_PATH_PARAM: ParameterObject & Dictionary<any>;
+export declare enum methods {
+    get = "get",
+    put = "put",
+    post = "post",
+    delete = "delete",
+    patch = "patch"
+}
+export declare enum parametersInsEnum {
+    query = "query",
+    path = "path",
+    cookie = "cookie",
+    header = "header",
+    file = "file"
+}
+export declare const parametersIn: string[];
+export declare const numberEnum: string[];

package/dist/generator/config.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.numberEnum = exports.parametersIn = exports.parametersInsEnum = exports.methods = exports.DEFAULT_PATH_PARAM = exports.DEFAULT_SCHEMA = exports.TypescriptFileType = exports.displayEnumLabelFileName = exports.interfaceFileName = exports.serviceEntryFileName = void 0;
+exports.serviceEntryFileName = 'index';
+exports.interfaceFileName = 'types';
+exports.displayEnumLabelFileName = 'displayEnumLabel';
+var TypescriptFileType;
+(function (TypescriptFileType) {
+    TypescriptFileType["interface"] = "interface";
+    TypescriptFileType["serviceController"] = "serviceController";
+    TypescriptFileType["serviceIndex"] = "serviceIndex";
+    TypescriptFileType["displayEnumLabel"] = "displayEnumLabel";
+})(TypescriptFileType || (exports.TypescriptFileType = TypescriptFileType = {}));
+exports.DEFAULT_SCHEMA = {
+    type: 'object',
+    properties: { id: { type: 'number' } },
+};
+exports.DEFAULT_PATH_PARAM = {
+    in: 'path',
+    name: null,
+    schema: {
+        type: 'string',
+    },
+    required: true,
+    isObject: false,
+    type: 'string',
+};
+var methods;
+(function (methods) {
+    methods["get"] = "get";
+    methods["put"] = "put";
+    methods["post"] = "post";
+    methods["delete"] = "delete";
+    methods["patch"] = "patch";
+})(methods || (exports.methods = methods = {}));
+// Possible values are "query", "path", "file", "header", "cookie". (https://swagger.io/specification/)
+var parametersInsEnum;
+(function (parametersInsEnum) {
+    parametersInsEnum["query"] = "query";
+    parametersInsEnum["path"] = "path";
+    parametersInsEnum["cookie"] = "cookie";
+    parametersInsEnum["header"] = "header";
+    parametersInsEnum["file"] = "file";
+})(parametersInsEnum || (exports.parametersInsEnum = parametersInsEnum = {}));
+exports.parametersIn = ['query', 'path', 'cookie'];
+exports.numberEnum = [
+    'integer',
+    'long',
+    'float',
+    'double',
+    'number',
+    'int',
+    'float',
+    'double',
+    'int32',
+    'int64',
+];

package/dist/generator/file.d.ts

@@ -0,0 +1,2 @@
+export declare const prettierFile: (content: string) => [string, boolean];
+export declare function writeFile(folderPath: string, fileName: string, content: string): boolean;

package/dist/generator/file.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeFile = exports.prettierFile = void 0;
+const tslib_1 = require("tslib");
+const sync_1 = require("@prettier/sync");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const prettier_config_cjs_1 = tslib_1.__importDefault(require("../../prettier.config.cjs"));
+const prettierFile = (content) => {
+    let result = content;
+    let hasError = false;
+    try {
+        result = (0, sync_1.format)(content, Object.assign(Object.assign({}, prettier_config_cjs_1.default), { parser: 'typescript', importOrderSeparation: false }));
+    }
+    catch (error) {
+        hasError = true;
+    }
+    return [result, hasError];
+};
+exports.prettierFile = prettierFile;
+function mkdir(dir) {
+    if (!(0, fs_1.existsSync)(dir)) {
+        mkdir((0, path_1.dirname)(dir));
+        (0, fs_1.mkdirSync)(dir);
+    }
+}
+function writeFile(folderPath, fileName, content) {
+    const filePath = (0, path_1.join)(folderPath, fileName);
+    mkdir((0, path_1.dirname)(filePath));
+    const [prettierContent, hasError] = (0, exports.prettierFile)(content);
+    (0, fs_1.writeFileSync)(filePath, prettierContent, {
+        encoding: 'utf8',
+    });
+    return hasError;
+}
+exports.writeFile = writeFile;

package/dist/generator/mockGenarator.d.ts

@@ -0,0 +1,6 @@
+import { OpenAPIObject } from '../type';
+export type genMockDataServerConfig = {
+    openAPI: OpenAPIObject;
+    mockFolder: string;
+};
+export declare const mockGenerator: ({ openAPI, mockFolder, }: genMockDataServerConfig) => void;

package/dist/generator/mockGenarator.js

@@ -0,0 +1,202 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockGenerator = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const lodash_1 = require("lodash");
+const mockjs_1 = tslib_1.__importDefault(require("mockjs"));
+const path_1 = require("path");
+const tiny_pinyin_1 = tslib_1.__importDefault(require("tiny-pinyin"));
+const log_1 = tslib_1.__importDefault(require("../log"));
+const index_1 = tslib_1.__importDefault(require("../parser-mock/index"));
+const util_1 = require("../parser-mock/util");
+const config_1 = require("./config");
+const file_1 = require("./file");
+mockjs_1.default.Random.extend({
+    country() {
+        const data = [
+            '阿根廷',
+            '澳大利亚',
+            '巴西',
+            '加拿大',
+            '中国',
+            '法国',
+            '德国',
+            '印度',
+            '印度尼西亚',
+            '意大利',
+            '日本',
+            '韩国',
+            '墨西哥',
+            '俄罗斯',
+            '沙特阿拉伯',
+            '南非',
+            '土耳其',
+            '英国',
+            '美国',
+        ];
+        return data[(0, util_1.getRandomInt)(0, data.length)];
+    },
+    phone() {
+        const phonepreFix = ['111', '112', '114', '136', '170', '180', '183'];
+        return (phonepreFix[(0, util_1.getRandomInt)(0, phonepreFix.length)] + mockjs_1.default.mock(/\d{8}/));
+    },
+    status() {
+        const status = ['success', 'error', 'default', 'processing', 'warning'];
+        return status[(0, util_1.getRandomInt)(0, status.length)];
+    },
+    authority() {
+        const authority = ['admin', 'user', 'guest'];
+        return authority[(0, util_1.getRandomInt)(0, authority.length)];
+    },
+    avatar() {
+        const avatar = [
+            'https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg',
+            'https://gw.alipayobjects.com/zos/rmsportal/udxAbMEhpwthVVcjLXik.png',
+            'https://gw.alipayobjects.com/zos/antfincdn/XAosXuNZyF/BiazfanxmamNRoxxVxka.png',
+            'https://gw.alipayobjects.com/zos/rmsportal/ThXAXghbEsBCCSDihZxY.png',
+            'https://gw.alipayobjects.com/zos/rmsportal/OKJXDXrmkNshAMvwtvhu.png',
+            'https://avatars0.githubusercontent.com/u/507615?s=40&v=4',
+            'https://avatars1.githubusercontent.com/u/8186664?s=40&v=4',
+        ];
+        return avatar[(0, util_1.getRandomInt)(0, avatar.length)];
+    },
+    group() {
+        const data = [
+            '体验技术部',
+            '创新科技组',
+            '前端 6 组',
+            '区块链平台部',
+            '服务技术部',
+        ];
+        return data[(0, util_1.getRandomInt)(0, data.length)];
+    },
+    label() {
+        const label = [
+            '很有想法的',
+            '小清新',
+            '傻白甜',
+            '阳光少年',
+            '大咖',
+            '健身达人',
+            '程序员',
+            '算法工程师',
+            '川妹子',
+            '名望程序员',
+            '大长腿',
+            '海纳百川',
+            '专注设计',
+            '爱好广泛',
+            'IT 互联网',
+        ];
+        return label[(0, util_1.getRandomInt)(0, label.length)];
+    },
+    href() {
+        const href = [
+            'https://preview.pro.ant.design/dashboard/analysis',
+            'https://ant.design',
+            'https://procomponents.ant.design/',
+            'https://umijs.org/',
+            'https://github.com/umijs/dumi',
+        ];
+        return href[(0, util_1.getRandomInt)(0, href.length)];
+    },
+});
+const genMockData = (example) => {
+    if (!example) {
+        return {};
+    }
+    if (typeof example === 'string') {
+        return mockjs_1.default.mock(example);
+    }
+    if (Array.isArray(example)) {
+        return mockjs_1.default.mock(example);
+    }
+    return Object.keys(example)
+        .map((name) => {
+        return {
+            [name]: mockjs_1.default.mock(example[name]),
+        };
+    })
+        .reduce((pre, next) => {
+        return Object.assign(Object.assign({}, pre), next);
+    }, {});
+};
+const genByTemp = ({ method, path, parameters, status, data, }) => {
+    if (!(0, lodash_1.includes)(config_1.methods, method.toLocaleLowerCase())) {
+        return '';
+    }
+    let securityPath = path;
+    (0, lodash_1.forEach)(parameters, (item) => {
+        if (item.in === 'path') {
+            securityPath = securityPath.replace(`{${item.name}}`, `:${item.name}`);
+        }
+    });
+    return `'${method.toUpperCase()} ${securityPath}': (req: Request, res: Response) => {
+    res.status(${status}).send(${data});
+  }`;
+};
+const genMockFiles = (mockFunction) => {
+    return (0, file_1.prettierFile)(` 
+/* eslint-disable */
+// @ts-ignore
+import { Request, Response } from 'express';
+
+export default {
+${mockFunction.join('\n,')}
+    }`)[0];
+};
+const mockGenerator = ({ openAPI, mockFolder, }) => {
+    const openAPIParse = new index_1.default(openAPI);
+    const docs = openAPIParse.parser();
+    const pathList = (0, lodash_1.keys)(docs.paths);
+    const { paths } = docs;
+    const mockActionsObj = {};
+    pathList.forEach((path) => {
+        const pathConfig = paths[path];
+        (0, lodash_1.keys)(pathConfig).forEach((method) => {
+            var _a, _b, _c;
+            const methodConfig = pathConfig[method];
+            if (methodConfig) {
+                let conte = (_b = (methodConfig.operationId ||
+                    ((_a = methodConfig === null || methodConfig === void 0 ? void 0 : methodConfig.tags) === null || _a === void 0 ? void 0 : _a.join('/')) ||
+                    path.replace('/', '').split('/')[1])) === null || _b === void 0 ? void 0 : _b.replace(/[^\w^\s^\u4e00-\u9fa5]/gi, '');
+                if (/[\u3220-\uFA29]/.test(conte)) {
+                    conte = tiny_pinyin_1.default.convertToPinyin(conte, '', true);
+                }
+                if (!conte) {
+                    return;
+                }
+                const response = (_c = methodConfig.responses) === null || _c === void 0 ? void 0 : _c['200'];
+                const data = genMockData(response === null || response === void 0 ? void 0 : response.example);
+                if (!mockActionsObj[conte]) {
+                    mockActionsObj[conte] = [];
+                }
+                const tempFile = genByTemp({
+                    method,
+                    path,
+                    parameters: methodConfig.parameters,
+                    status: '200',
+                    data: JSON.stringify(data),
+                });
+                if (tempFile) {
+                    mockActionsObj[conte].push(tempFile);
+                }
+            }
+        });
+    });
+    Object.keys(mockActionsObj).forEach((file) => {
+        if (!file || (0, lodash_1.isUndefined)(file)) {
+            return;
+        }
+        if (file.includes('/')) {
+            const dirName = (0, path_1.dirname)((0, path_1.join)(mockFolder, `${file}.mock.ts`));
+            if (!fs_1.default.existsSync(dirName)) {
+                fs_1.default.mkdirSync(dirName);
+            }
+        }
+        (0, file_1.writeFile)(mockFolder, `${file}.mock.ts`, genMockFiles(mockActionsObj[file]));
+    });
+    (0, log_1.default)('✅ 生成 mock 文件成功');
+};
+exports.mockGenerator = mockGenerator;

package/dist/generator/serviceGenarator.d.ts

@@ -0,0 +1,31 @@
+import type { GenerateServiceProps } from '../index';
+import { OpenAPIObject } from '../type';
+import { ControllerType, TagAPIDataType } from './type';
+export default class ServiceGenerator {
+    protected apiData: TagAPIDataType;
+    protected classNameList: ControllerType[];
+    protected finalPath: string;
+    protected config: GenerateServiceProps;
+    protected openAPIData: OpenAPIObject;
+    constructor(config: GenerateServiceProps, openAPIData: OpenAPIObject);
+    genFile(): void;
+    private getInterfaceTPConfigs;
+    private getServiceTPConfigs;
+    private genFileFromTemplate;
+    private getTemplate;
+    private getFuncationName;
+    private getType;
+    private getTypeName;
+    private getBodyTP;
+    private getFileTP;
+    private resolveFileTP;
+    private getResponseTP;
+    private getParamsTP;
+    private resolveObject;
+    private resolveArray;
+    private resolveProperties;
+    private resolveEnumObject;
+    private resolveAllOfObject;
+    private getProps;
+    private resolveRefObject;
+}