源码改造

为了满足不同场景的需求，而不仅仅只是umi，所以我对此做了如下改造：

接口文件名以xxxController.ts命名
系统内置多种请求库模版，如：axios、umi-request
支持用户自定义接口模版

接口命名

命名主要使用xxxController.ts

tags.forEach((tagString) => { // 遍历每个标签字符串
    const tag = this.config.isCamelCase // 根据配置决定是否将标签转换为驼峰命名
        ? camelCase(resolveTypeName(tagString)) // 转换为驼峰命名
        : resolveTypeName(tagString); // 保持原样

    // New logic to use the description for the controller name
    const tagInfo = this.openAPIData.tags.find(t => t.name === tagString);
    const controllerName = tagInfo ? `${tagInfo.description.replace(/\s+/g, '')}Controller` : `${tag}Controller`;

    if (!this.apiData[controllerName]) { // 如果 apiData 中没有该标签，则初始化为空数组
        this.apiData[controllerName] = []; // 初始化标签数组
    }
    this.apiData[controllerName].push({ // 将当前操作对象的信息推入对应标签的数组中
        path: `${basePath}${p}`, // 完整路径
        method, // HTTP 方法
        ...operationObject, // 其他操作对象属性
    });
});

多种模版库

修改GenerateServiceProps，新加两个字段：

requestLibrary?: RequestLibrary;
customServicePath?: string; // 如果requestLibrary为custom，那么需要传入自定义的Controller位置

默认支持的请求库

//默认支持的请求库
export type RequestLibrary = 'umi' | 'axios' | 'fetch' | 'request' | 'custom';

在使用的时候，传入需要使用的请求库类型：

例如使用umi：

await openAPI.generateService({
    schemaPath: `${__dirname}/openapi-doc/openapi.json`,
    serversPath: './test/gen/umi',
    requestLibrary: 'umi',
});

将类型传入构造函数，并且如果用户不传requestLibrary，那么我们默认给umi：

// 从 appName 生成 service 数据
export const generateService = async (
    {
        requestLibPath,
        schemaPath,
        mockFolder,
        nullable = false,
        requestOptionsType = '{[key: string]: any}',
        requestLibrary = 'umi',
        ...rest
    }: GenerateServiceProps) => {
    const openAPI = await getOpenAPIConfig(schemaPath);
    const requestImportStatement = getImportStatement(requestLibPath);
    const serviceGenerator = new ServiceGenerator(
        {
            requestLibrary,
            namespace: 'API',
            requestOptionsType,
            requestImportStatement,
            enumStyle: 'string-literal',
            nullable,
            isCamelCase: true,
            ...rest,
        },
        openAPI,
    );
    serviceGenerator.genFile();
};

修改获取模版的方法：

private getTemplate(type: 'interface' | 'serviceController' | 'serviceIndex'): string {
    //如果this.config.requestLibrary 在RequestLibrary中 那么serviceController的模版位置=templatesFolder/this.config.requestLibrary/requestLibrary.njk
    if (type === 'serviceController') {
        if (this.config.requestLibrary != 'custom') {
            return readFileSync(
                join(this.config.templatesFolder, this.config.requestLibrary, 'serviceController.njk'),
                'utf8',
            );
        }
        return readFileSync(this.config.customServicePath, 'utf-8');
    }
    return readFileSync(join(this.config.templatesFolder, `${type}.njk`), 'utf8');
}

这里如果是serviceController，也就是想要生成接口，那么我们就根据接口库类型，去对应的额文件夹下面找njk模版，所以我们的模版文件夹目录长这样：

自定义模版

如果用户有自己对请求库的定义，可以自己编写模版文件：

    //测试自定义模板路径
    Log("😘正在测试自定义模版路径")
    await openAPI.generateService({
        schemaPath: `${__dirname}/openapi-doc/openapi.json`,
        serversPath: './test/gen/custom',
        requestLibrary: 'custom',
        customServicePath: 'test/custom-service-template'
    });

在使用的时候，需要同时传入requestLibrary=custom和customServicePath

在构造器中，给用户拼接完整的路径：

        if (this.config.requestLibrary === 'custom') {
            this.config.customServicePath = join(process.cwd(), this.config.customServicePath)
        }

然后读取模版的时候，读取this.config.customServicePath，也就是用户自定义的路径：

    if (type === 'serviceController') {
        if (this.config.requestLibrary != 'custom') {
            return readFileSync(
                join(this.config.templatesFolder, this.config.requestLibrary, 'serviceController.njk'),
                'utf8',
            );
        }
        return readFileSync(this.config.customServicePath, 'utf-8');
    }

运行测试

测试代码：

import Log from "../src/log";

const openAPI = require('../src/index.ts');

const gen = async () => {
    //测试自定义模板路径
    Log("😘正在测试自定义模版路径")
    await openAPI.generateService({
        schemaPath: `${__dirname}/openapi-doc/openapi.json`,
        serversPath: './test/gen/custom',
        requestLibrary: 'custom',
        customServicePath: 'test/custom-service-template'
    });

    //测试umi模版
    Log("😘正在测试umi模版")
    await openAPI.generateService({
        schemaPath: `${__dirname}/openapi-doc/openapi.json`,
        serversPath: './test/gen/umi',
        requestLibrary: 'umi',
        customServicePath: 'test/custom-service-template'
    });

    //测试axios模版
    Log("😘正在测试axios模版")
    await openAPI.generateService({
        schemaPath: `${__dirname}/openapi-doc/openapi.json`,
        serversPath: './test/gen/axios',
        requestLibrary: 'axios',
        customServicePath: 'test/custom-service-template'
    });
}
gen()

测试结果：

生成的axios格式的请求：

生成的umi格式

自定义格式：

接口命名​

多种模版库​

自定义模版​

运行测试​

接口命名

多种模版库

自定义模版

运行测试