本文介绍: 平时在和后端对接时,总是要把后端swagger声明好的类型ts中再实现一遍,写一堆interface今天推荐一个库,可以根据swagger文档直接生成typescriptjavascript代码,并且有良好的代码提示。由于也自动生成了相应的declare文件,所以就算是js也会有很好的代码提示

依据 swaggeropenapi文档一键生成 typescriptjavascript 代码

平时在和后端对接时,总是要把后端swagger声明好的类型ts中再实现一遍,写一堆interface今天推荐一个库,可以根据swagger文档直接生成tsjs代码,并且有良好的代码提示

注意:swagger文档版本需要3.0及以上

先上效果图

swagger文档
在这里插入图片描述

已生成的代码

1.安装脚手架


npm i -g @zeronejs/cli

2.打开你的项目

这里快速创建


npm ini -y

然后创建一个swagger.config.json文件

配置示例:


{
   "docsUrl": "http://www.example.com/v3/api-docs",
   "axiosInstanceUrl": "axios"
}

示例

其中docsUrl指的是swagger页面json链接地址

swagger文档

json地址

当然你也可以指定本地json文件

示例

3.运行命令

3.1 ts代码

zerone api

3.2 js代码

生成js依赖于axios,请先安装axios


npm install axios

zerone api -js

image

代码生成执行成功!!

4. 实战操作

通常我们项目不在根目录,稍微修改下…

我们swagger.config.jsondocs.json 放在 /src/api 下,如果需要创建axios实例的话,axiosInstanceUrl换成实例地址

image

4.1运行命令

ts代码

zerone api -p ./src/api

js代码

zerone api -js -p ./src/api

image

生成成功!

由于也自动生成了相应的declare文件,所以就算是js也会有很好的代码提示

image

完整demo代码:https://gitee.com/zzh948498/swagger-to-ts

官方文档地址zeronejs (ps: 文档目前挂载github上)

源码地址:https://github.com/zeronejs/zerone

原文地址:https://blog.csdn.net/weixin_44241402/article/details/128964496

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任

如若转载,请注明出处:http://www.7code.cn/show_40654.html

如若内容造成侵权/违法违规/事实不符,请联系代码007邮箱suwngjj01@126.com进行投诉反馈,一经查实,立即删除

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注