作者:IAmor
https://juejin.cn/post/7295343805020274698
刚做完公司项目的新架构,决定使用TS来解决项目中的类型问题,但是在写接口类型的时候,发现了一个问题,就是接口类型的定义,如果是一个复杂的类型,那么就会变得非常的麻烦。
每个接口的request,response不能说一点不相同,只能说完全不相同。甚至写类型的时间比写逻辑的时间都长。往往写到一半TS变成了AS。回过头来又对自己写AS的行为感到羞愧。
后来聪明的我想,Java他还能不写VO类吗?他写了我能不能直接用?
然后就有了这篇文章。
如何能获取到Java的VO类呢?作为前端开发,我们能获取到的数据只有接口文档,那么我们能不能通过接口文档来生成VO类呢?
答案是肯定的。
获取到接口文档后,一开始甚至想自己写套转换工具。写着写着发现,这个工具的难度比写接口类型还大。于是放弃了。
然后,swagger-typescript-api 出现了。
swagger-typescript-api;
官方提供了两种使用方式。使用npx或者使用node的方式进行;个人建议还是使用node的方式,可以按照个人或公司的实际需求进行。该插件核心是通过解析swagger文档,通过模板生成TS类型甚至连ajax请求都替我们写好了。
支持ajax和fetch两种请求方式。
通过源码的阅读,在/templates下内置了3套模板
default生成单个api文件,modular可以根据指定的命名空间生成多个api文件,base既可以生成单个api文件可以生成多个api文件;
举个简单的例子:接口文档有User,Book 两个controller
// api.ts
UserApi,
BookApi
// user.ts
UserApi
// book.ts
BookApi
我们通常使用base模板中的modular模式来使用。没有人会想不同模板的接口放在一个页面中维护吧。为什选择 base模板,因为base模板提供了更全面的配置模板。
base模板中的模板文件如下
我们常用的有着重讲解
讲解开始前来一段swagger的文档,结合着看
{
"swagger": "",
"info": "",
"host": "",
"basePath": "",
"tags": [
{
"name": "通用接口",
"x-order": "2147483647"
}
],
"paths": {
"post": {
"tags": [
"通用接口"
],
"summary": "获取活动列表",
"operationId": "getActivityPageListUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"originalRef": "CommonActivityPageRequest",
"$ref": "#/definitions/CommonActivityPageRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "IPage«CommonActivityPageResponse»",
"$ref": "#/definitions/IPage«CommonActivityPageResponse»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"x-order": "2147483647"
}
},
"definitions": {
"CommonActivityPageResponse": {
"type": "object",
"properties": {
"activityName": {
"type": "string",
"description": "活动名称"
},
"activityType": {
"type": "integer",
"format": "int32",
"description": "活动类型"
},
"title": "CommonActivityPageResponse"
}
}
}
}
其中主要部分包含tags, path,definitions,根据其中信息,使用插件生成后的代码如下
// type.ts
/** CommonActivityPageRequest */
export interface CommonActivityPageRequest {
/** 活动名称,支持模糊查询 */
activityName?: string;
/** 活动类型,支持多选 */
activityType?: number[];
}
// http-client.ts
import axios, { AxiosInstance, AxiosRequestConfig, HeadersDefaults, ResponseType } from "axios";
export type QueryParamsType = Record<string | number, any>;
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
/** set parameter to `true` for call `securityWorker` for this request */
secure?: boolean;
/** request path */
path: string;
/** content type of request body */
type?: ContentType;
/** query params */
query?: QueryParamsType;
/** format of response (i.e. response.json() -> format: "json") */
format?: ResponseType;
/** request body */
body?: unknown;
}
export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
...sth
export const httpRequest = new HttpClient();
// commion.ts
/**
* @tags 通用接口
* @summary 获取活动列表
* @request POST:/common/getActivityPageList
*/
export const getActivityPageList = (request: CommonActivityPageRequest): Promise<IPageCommonActivityPageResponse> => {
return httpRequest({
url: '/common/getActivityPageList',
method: 'post',
data: request,
});
};
该模板是用于生成API接口文档的JSDoc注释的。它会解析Raw API规范数据,并生成符合JSDoc标准的注释文档。
主要逻辑如下:
上方解析结果中的注释部分由该文件控制。
用来生成API服务接口的TypeScript client代码的。通用与procedure-call.ejs一起使用,主要包含以下几个方面
api.ejs中所需的生成模板内容,它通过模板引擎,根据API路由配置自动生成发起请求的函数。主要功能包括:
生成http客户端的模板。主要用途如下:
生成http客户端的入口文件在此可在初始化时选择使用fetch or axios;
生成接口的request和response类型,主要是通过definitions中的数据生成的。
此时的目录结构应该如下:
|- templates
| - | - base
| - | - | - route-docs.ejs
| - | - api.ejs
| - | - procedure-call.ejs
| - | - axios-http-client.ejs
| - | - http-client.ejs
| - | - route-type.ejs
| - generator.js
我们通常在generator进行初始化。具体配置参照官方文档
我的配置文件
const options = {
url: openApiUrl, //openapi接口url
output: outputDir, //输出目录
templates: path.resolve(__dirname, 'templates'), //模板目录
modular: true, // 为客户端、数据类型和路由生成单独的文件
cleanOutput: false, //清除输出目录
enumNamesAsValues: false,
moduleNameFirstTag: false,
generateUnionEnums: false,
extractRequestBody: true, // 生成请求体类型
extractRequestParams: true, //提取请求参数,将路径参数和查询参数合并到一个对象中
unwrapResponseData: true, // 从响应中展开数据项 res 或 res.data
httpClientType: 'axios', // 可选 'fetch' //http客户端类型
defaultResponseAsSuccess: false,
generateClient: true, //生成http客户端
generateRouteTypes: false, //生成路由器类型
generateResponses: false, //生成响应类型
defaultResponseType: 'void',
typePrefix: '', // 类型前缀
typeSuffix: '', // 类型后缀
enumKeyPrefix: '', // 枚举key前缀
enumKeySuffix: '', // 枚举key后缀
addReadonly: false, // 设置只读
/** 允许根据这些额外模板生成额外文件,请参阅下文 */
extraTemplates: [],
anotherArrayType: false,
fixInvalidTypeNamePrefix: 'Type', //修复无效类型名称前缀
fixInvalidEnumKeyPrefix: 'Value', //修复无效枚举键前缀
hooks: {
onPrepareConfig: (currentConfiguration) => {
const config = currentConfiguration.config
config.fileNames.httpClient = 'httpClient' //http客户端文件名
config.fileNames.dataContracts = 'types' //类型文件名
return {...currentConfiguration, config}
},
onFormatRouteName: (routeInfo, templateRouteName) => {
if (routeInfo.method === 'get') {
return `Get${lodash.upperFirst(routeInfo.moduleName)}Request`;
}
return templateRouteName;
},
onPreParseSchema: (originalSchema, typeName, schemaType) => {
if (originalSchema.type === 'integer' && originalSchema.format === 'int64') {
originalSchema.type = 'string';
originalSchema.format = 'string';
}
},
}
};
generateApi(options)
其中generateApi方法是官方提供的方法,用于生成api文件。该方法返回promise,可以在其生成后在进行其他额外的配置。
比如将首字母大写,将文件名改为index.ts等等。
generateApi(options).then(({files, configuration}) => {
// do something
})
我们只要在接口文档更新后,每次使用node执行generator.js文件即可每次更新。使用也只需要在需要的地方导入接口即可。
一个字真他妈爽!
该插件已经投入生产环境使用,也遇到了一些问题。
对后端代码来说,注释规范要求极高。否则生成的接口文档会出现问题。
还有其他小问题总之不会特别影响开发使用,欢迎大家使用后随时交流。
— 完 —
关注公众号后,回复下面关键词获取回复 加群,加入前端程序员技术交流群回复 面试,获取最新大厂面试资料回复 简历,获取 3200 套 简历模板回复 TypeScript,获取 TypeScript 精讲课程回复 uniapp,获取 uniapp 精讲课程回复 Node,获取 Nodejs+koa2 实战教程回复 架构师,获取 架构师学习资源教程更多教程资源应用尽有,欢迎 关注获取
“分享、点赞、在看” 支持一波👍