本文介绍: 平时在和后端对接时,总是要把后端swagger声明好的类型在ts中再实现一遍,写一堆interface;今天推荐一个库,可以根据swagger文档,直接生成typescript 或 javascript代码,并且有良好的代码提示。由于也自动生成了相应的declare文件,所以就算是js也会有很好的代码提示。
依据 swagger(openapi) 文档一键生成 typescript 或 javascript 代码
平时在和后端对接时,总是要把后端swagger声明好的类型在ts中再实现一遍,写一堆interface;今天推荐一个库,可以根据swagger文档,直接生成ts 或 js代码,并且有良好的代码提示
先上效果图
1.安装脚手架
npm i -g @zeronejs/cli
2.打开你的项目
npm ini -y
{
"docsUrl": "http://www.example.com/v3/api-docs",
"axiosInstanceUrl": "axios"
}
其中docsUrl指的是swagger页面上json链接地址
3.运行命令
3.1 ts代码
zerone api
3.2 js代码
npm install axios
zerone api -js
4. 实战操作
我们把swagger.config.json
和 docs.json
放在 /src/api 下,如果需要创建axios实例的话,axiosInstanceUrl
换成实例的地址
4.1运行命令
ts代码
zerone api -p ./src/api
js代码
zerone api -js -p ./src/api
生成成功!
由于也自动生成了相应的declare文件,所以就算是js也会有很好的代码提示
完整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进行投诉反馈,一经查实,立即删除!
声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。