1.1.1 • Published 1 year ago

api-code-creater v1.1.1

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

api-code-creater

介绍

解析后端提供的api文档，自动为前端生成相应的请求调用函数代码。

相关

  • 文档解析要求：目前仅支持解析OpenApi3的JSON文件。
  • 核心生成机制：按照同一首路径对api进行分组，一组api所有函数声明生成一个同组名的函数声明文件(.ts)，并将所有函数声明文件中用到的引用类型合并生成一个类型声明文件(.d.ts)。
  • 特色优势：
    • 默认以vue常用的axios封装api请求格式为模板，方便vue项目开发。
    • 提供了大量内置可用的模板数据，以便自定义其他样式的模板，提高兼容。
    • 提供对生成的函数名与类型名的修正 与 排序处理。
    • 支持ts、js两种格式代码的生成选择。

基础用法

步骤1：安装生成器

npm i api-code-creater --save-dev

步骤2：在项目根目录新建 api.config.js, 用以配置生成器的执行函数

const {generateService} = require('api-code-creater')
const path = require("path");

generateService({
    inputFilePath: path.join(__dirname, './openapi.json'),
    outputDirPath: path.join(__dirname, './src/api'),
})

步骤3：在 package.json 的 script 中添加 生成api的脚本命令: 

{
  "scripts": {
    "api": "node api.config.js"
  }
}

步骤4：生成api

npm run api

配置说明

基础必填项：

生成器执行函数必须填写如下两个参数，以确定解析文档路径 与 生成代码存放路径：

参数描述
inputFilePath输入文件路径（后端Api文件的json文件的路径）
outputDirPath输出目录路径（生成Api代码的存放目录）
generateService({
    inputFilePath: path.join(__dirname, './openapi.json'),
    outputDirPath: path.join(__dirname, './src/api'),
})

可选功能项：

1. 设置生成样式

生成器默认基于内置的axios模板完成函数声明文件与类型声明文件中的内容生成，可以采用：

  • 默认模式 - 选择基于axios封装请求的固定内容格式
  • 自定义模式 - 自由定义内容格式

需要注意的是：采用默认axios模板时，项目中axios请求需设置响应成功返回response.data，而非response!

1）生成模式

生成器支持ts、js两种格式的代码生成。

默认情况下，生成器处于ts生成模式下，会生成ts格式的 函数声明文件 与 类型声明文件；

若想切换到js生成模式下，仅生成js格式的函数声明文件，设置genMode参数为js即可：

// 切换到js生成模式
generateService({
  ...,
  genMode: "js",
})

需要注意的是：设置处于js生成模式，后续一些关于类型的配置项会失效！

2）公共函数文件头

默认情况下，每一个函数声明文件的头部都存在语句import request from '@/utils/request';

若要自定义所有函数声明文件的公共文件头，可通过funFileHeads参数设置：

// 假设1：
// 以如下一条语句提高默认语句：
// import request from './utils/request';
generateService({
  ...,
  funFileHeads: ["import request from './utils/request';"],
})
// 假设2：
// 想每个函数声明文件的头部都依次存在如下一些语句：（默认语句不再存在）
// import aaa from '@/aaa';
// import bbb from '@/bbb';
// import ccc from '@/ccc';
generateService({
  ...,
  funFileHeads: [
    "import aaa from '@/aaa';",
    "import bbb from '@/bbb';",
    "import ccc from '@/ccc';"
  ],
})
3）函数参数风格

通过funParamMode参数进行函数参数风格的设置，其存在两种可选模式：

  • 'default': 默认参数模式，函数的参数会呈现所有
  • 'simple': 简洁参数模式，函数的参数会聚合为 路径参数、查询参数、body参数
模式配置效果示例
默认参数模式缺省funParamMode参数 或 funParamMode: "default"如：listUsers(keyword:string,pageSize:number,pageNum:number)
简洁参数模式funParamMode: "simple"如：listUsers(params:UserListParam)
4）函数类型风格

通过funTypeMode参数进行函数类型风格的设置，其存在两种可选模式：

  • 'default': 默认类型模式，函数的类型按文档中原类型进行显示
  • 'generics': 泛型类型模式，函数的类型会基于通用返回类型呈现泛型，需同步配置commonReturnTypes
模式配置效果示例
默认类型模式缺省funTypeMode参数 或 funTypeMode: "default"如：getUser(id:number):Promise<CommonResultUser>{...}
泛型类型模式funTypeMode: "generics" 并 commonReturnTypes: ['CommonResult', 'CommonPage']如：getUser(id:number):Promise<CommonResult<User>>{...}

注：此处泛型配置中的commonReturnTypes需按实际后端提供api文档来填写，这里是假设后端提供api中存在通用返回类型CommonResult与CommonPage，这样包含这两个字符串的所有类型都会自动据此分割成泛型！

5）声明类型的作用域

声明类型：类型声明文件中声明的类型，函数声明文件中会引用作为某些函数中某个参数类型或返回值类型

通过typeScope参数设置声明类型的作用域，其存在三种可选模式：

  • 'module': 缺省默认的模块范围类型模式，类型仅限导入其所在声明文件的模块使用
  • 'namespace': 命名空间范围类型模式，类型可全局通过指定命令空间调用（默认命名空间名为API，若需改动需自定义namespaceId值）
  • 'global': 全局范围类型模式，类型可全局调用，但需注意类型名全局唯一可能发生命名冲突（通常不建议使用！！！）

注：若为 namespace 或 global，其最终生成的类型声明文件需加入TypeScript编译，其他ts文件才能正常解析该文件中声明的全局类型

模式配置效果示例（示例采用默认类型模式）
模块范围类型模式缺省typeScope参数 或 typeScope: "module"如：getUserInfo():Promise<CommonResultUserInfoResult>{...}且该函数声明文件头存在相关类型的import导入语句
命名空间范围类型模式typeScope: "namespace"如：getUserInfo():Promise<API.CommonResultUserInfoResult>{...}
全局范围类型模式typeScope: "global"如：getUserInfo():Promise<CommonResultUserInfoResult>{...}
6) 显示 Content-Type 请求头

通过showContentTypes参数进行函数Content-Type请求头的显示设置，其值为仅包含如下一些可填字符串的数组：

  • 'application/json'
  • 'application/x-www-form-urlencoded'
  • 'multipart/form-data'

这些字符串代表可被显示的Content-Type，当函数对应请求Content-Type符合且要携带body数据时， 则会在函数中显示相应的Content-Type请求头代码，格式类似headers: { 'Content-Type': 'xxx' }。

注：缺省未明确设置的情况下，默认仅不允许显示 'application/json'，其他Content-Type都允许显示，即等同于 showContentTypes: ['application/x-www-form-urlencoded', 'multipart/form-data']

7）自定义模板

通过templatesFolder参数设置自定义模板的查找目录，然后在此目录下新建函数声明模板与类型声明模板：

  • api-funs.mustache：函数声明模板
  • api-types.mustache：类型声明模板

模板需使用Mustache语法进行编辑，且存在如下一些内置可用的模板数据：

函数声明文件模板.png 类型声明文件模板.png

2. 名称修正处理

可通过funNameFixRules参数与typeNameFixRules参数分别修正 函数文件中的函数名 与 类型文件中的类型名，其值如下修正规则对象数组。

修正规则对象：

规则参数描述类型注意
target针对函数名或类型名的匹配目标字符串string | RegExpfunNameFixRules参数时以函数名为查找目标，typeNameFixRules参数时以类型名为查找目标若为string字符串时，执行完全匹配，指所有完全与该值相同的函数名或类型名所在的字符串对象若为RegExp对象时，执行正则匹配，仅指符合该值匹配规则的函数名或类型名中的匹配部分
replaceValue针对匹配目标字符串的替换值(groupName?:string)=>string | (typeName?:string)=>stringfunNameFixRules参数时,提供默认groupName参数代表目标函数所在的组名（注：同一url首路径划分为一组）typeNameFixRules参数时, 提供默认typeName参数代表目标类型所在的字符串名
// 假设：
// 想所有api的url对应函数名，都如下/user/xxx的一样进行修正：
// /user/{id} => 默认请求函数名为：{id} => 想修改函数名为：getUser
// /user/info => 默认请求函数名为：info => 想修改函数名为：getUserInfo
// /user/create => 默认请求函数名为：create => 想修改函数名为：addUser
// /user/list => 默认请求函数名为：list => 想修改函数名为：listUsers
// /user/listAll => 默认请求函数名为：listAll => 想修改函数名为：listAllUsers
// /user/update => 默认请求函数名为：update => 想修改函数名为：updateUser
// /user/delete => 默认请求函数名为：delete => 想修改函数名为：deleteUser
// /user/deleteList => 默认请求函数名为：deleteList => 想修改函数名为：deleteUserList
generateService({
  ...,
  funNameFixRules: [
    {target: "{id}", replaceValue: (groupName) => "get"+ toCapitalize(groupName)},
    {target: "info", replaceValue: () => "getUserInfo"},
    {target: "create", replaceValue: (groupName) => "add" + toCapitalize(groupName)},
    {target: "list", replaceValue: (groupName) => "list" + toCapitalize(groupName) + 's'},
    {target: "listAll", replaceValue: (groupName) => "listAll" + toCapitalize(groupName) + 's'},
    {target: "update", replaceValue: (groupName) => "update" + toCapitalize(groupName)},
    {target: "delete", replaceValue: (groupName) => "delete" + toCapitalize(groupName)},
    {target: "deleteList", replaceValue: (groupName) => "delete" + toCapitalize(groupName) + "List"},
  ],
})

// 假设：
// 有些声明类型存在_request后缀 => 想修改类型名Xxx_request为Xxx
// 有些声明类型存在_response后缀 => 想修改类型名Xxx_response为Xxx
// 泛型类型模式下，有些声明类型错误显示有<>字符串 => 想修改类型名Xxx<>为Xxx（可能报错，泛型无变量）
// 泛型类型模式下，有些泛型类型无变量使用报错，需设置默认变量 => 想修改类型名Xxx<>为Xxx（正确）
// 泛型类型模式下，有些泛型类型的泛型变量错误 => 想修改类型名Xxx<ListYyy>为Xxx<Yyy[]>
// 泛型类型模式下，有些泛型类型的泛型变量错误 => 想修改类型名CommonPage<Yyy>为CommonPage<Yyy[]>
generateService({
  ...,
  typeNameFixRules: [
    {target: /_request/, replaceValue: () =>  ''},
    {target: /_response/, replaceValue: () =>  ''},
    {target: /<>/, replaceValue: () =>  ''},
    {target: /<Type>/, replaceValue: () =>  '<Type={}>'},
    {target: /(?<=List[a-zA-Z]+)>/, replaceValue: () => '[]>'},         // Xxx<ListYyy> => Xxx<ListYyy[]> ， 为达到 Xxx<ListYyy> => Xxx<Yyy[]> 的必要步骤1
    {target: /<List/, replaceValue: () => '<'},                         // Xxx<ListYyy[]> => Xxx<Yyy[]> ， 为达到 Xxx<ListYyy> => Xxx<Yyy[]> 的必要步骤2
    {target: /(?<=CommonPage<[a-zA-Z]+)>/, replaceValue: () => '[]>'},  // CommonPage<Yyy> => CommonPage<Yyy[]>
  ],
})

注：生成器内置了一个NameConversionTool名称转换工具类，其中存在toCapitalize函数可转换字符串为首字母大写剩下小写的格式

3. 数据排序处理

可通过funSortRules参数与typeSortRules参数分别为 函数文件中的函数数据 与 类型文件中的类型数据 进行排序处理：

  • 排序数组的元素，可为具体函数名字符串/类型名字符串，也可为符合指定一定规则的函数名正则表达式/类型名正则表达式
  • 排序数组的元素所代表的函数名/类型名，其数组序号越小 对应 生成的函数/类型越靠前，也即前置排序
  • 排序数组的元素规则，若出现重复匹配，则以后置规则为准，即同名函数/类型数据仅按最后一个规则进行排序
// 假设：
// 想按如右顺序排列类型数据: addXxx > getXxx > listXxx > listAllXxx > updateXxx > deleteXxx > deleteXxxList > allocXxx
generateService({
  ...,
  funSortRules: [/^add/, /^get(?!UserInfo)/, /^list/, /^listAll/, /^update/, /^delete/, /^delete[a-zA-Z]+List$/, /^alloc/],
})
// 假设：
// 想按如右顺序排列类型数据: CommonXxx > XxxParam > XxxResult
generateService({
    ...,
    typeSortRules: [/^Common/, /Param$/, /Result$/],
})

示例

ts格式示例

api.config.js配置：

const {generateService, NameConversionTool} = require('api-code-creater');
const path = require("path");
const {toCapitalize} = NameConversionTool;

generateService({
  inputFilePath: "./openapi.json",
  outputDirPath: path.join(__dirname, "./src/api"),
  // templatesFolder: ".\\dist\\templates",

  // genMode: 'ts',
  // funFileHeads: ["import request from '@/utils/request';"],
  funParamMode: "simple",
  funTypeMode: "generics",
  commonReturnTypes: ['CommonResult', 'CommonPage'],
  typeScope: "module",
  // typeScope: "namespace",
  // namespaceId: "API",
  // typeScope: "global",
  // showContentTypes: ['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'],

  funNameFixRules: [
    {target: "{id}", replaceValue: (groupName) => "get" + toCapitalize(groupName)},                     // {id} => getXxx
    {target: "info", replaceValue: () => "getUserInfo"},                                                // info => getUserInfo
    {target: "create", replaceValue: (groupName) => "add" + toCapitalize(groupName)},                   // create => addXxx
    {target: "list", replaceValue: (groupName) => "list" + toCapitalize(groupName) + 's'},              // list => listXxxs
    {target: "listAll", replaceValue: (groupName) => "listAll" + toCapitalize(groupName) + 's'},        // listAll => listAllXxxs
    {target: "update", replaceValue: (groupName) => "update" + toCapitalize(groupName)},                // update => updateXxx
    {target: "delete", replaceValue: (groupName) => "delete" + toCapitalize(groupName)},                // delete => deleteXxx
    {target: "deleteList", replaceValue: (groupName) => "delete" + toCapitalize(groupName) + "List"},   // deleteList => deleteXxxList
  ],
  typeNameFixRules: [
    {target: /_request/, replaceValue: () => ''},                       // Xxx_request => Xxx
    {target: /_response/, replaceValue: () => ''},                      // Xxx_response => Xxx
    {target: /<>/, replaceValue: () => ''},                             // Xxx<> => Xxx
    {target: /<Type>/, replaceValue: () => '<Type={}>'},                // Xxx<Type> => Xxx<Type={}> ， 也即让 CommonResult 能直接使用不带泛型变量
    {target: /(?<=List[a-zA-Z]+)>/, replaceValue: () => '[]>'},         // Xxx<ListYyy> => Xxx<ListYyy[]> ， 为达到 Xxx<ListYyy> => Xxx<Yyy[]> 的必要步骤1
    {target: /<List/, replaceValue: () => '<'},                         // Xxx<ListYyy[]> => Xxx<Yyy[]> ， 为达到 Xxx<ListYyy> => Xxx<Yyy[]> 的必要步骤2
    {target: /(?<=CommonPage<[a-zA-Z]+)>/, replaceValue: () => '[]>'},  // CommonPage<Yyy> => CommonPage<Yyy[]>
  ],

  funSortRules: [/^add/, /^get(?!UserInfo)/, /^list/, /^listAll/, /^update/, /^delete/, /^delete[a-zA-Z]+List$/, /^alloc/],
  typeSortRules: [/^Common/, /Param$/, /Result$/],
})

生成：

api代码生成效果.png

js格式示例

api.config.js配置：

const {generateService, NameConversionTool} = require('api-code-creater');
const path = require("path");
const {toCapitalize} = NameConversionTool;

generateService({
  inputFilePath: "./openapi.json",
  outputDirPath: path.join(__dirname, "./src/api"),
  // templatesFolder: ".\\dist\\templates",

  genMode: 'js',
  // funFileHeads: ["import request from '@/utils/request';"],
  funParamMode: "simple",
  // showContentTypes: ['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'],

  funNameFixRules: [
    {target: "{id}", replaceValue: (groupName) => "get" + toCapitalize(groupName)},                     // {id} => getXxx
    {target: "info", replaceValue: () => "getUserInfo"},                                                // info => getUserInfo
    {target: "create", replaceValue: (groupName) => "add" + toCapitalize(groupName)},                   // create => addXxx
    {target: "list", replaceValue: (groupName) => "list" + toCapitalize(groupName) + 's'},              // list => listXxxs
    {target: "listAll", replaceValue: (groupName) => "listAll" + toCapitalize(groupName) + 's'},        // listAll => listAllXxxs
    {target: "update", replaceValue: (groupName) => "update" + toCapitalize(groupName)},                // update => updateXxx
    {target: "delete", replaceValue: (groupName) => "delete" + toCapitalize(groupName)},                // delete => deleteXxx
    {target: "deleteList", replaceValue: (groupName) => "delete" + toCapitalize(groupName) + "List"},   // deleteList => deleteXxxList
  ],

  funSortRules: [/^add/, /^get(?!UserInfo)/, /^list/, /^listAll/, /^update/, /^delete/, /^delete[a-zA-Z]+List$/, /^alloc/],
})

生成：

api代码生成效果（js格式）.png

tsjsapicodecodegenOpenApiapi代码生成器
mustacheopenapi3-ts
1.1.1

1 year ago

1.1.0

1 year ago

1.0.1

2 years ago

1.0.0

2 years ago