swagger接口文件转前端axios+typescript文件

如果你使用过后端生成的swagger接口文档,那么肯定会有疑问,能不能直接生成接口文件呢,这样前端不就省事了。经过和后端同事的研究发现了swagger-typescript这个工具正好可以帮我们做这样的事情。好了废话不多说开始正文

安装依赖 @wynnyo/swagger-typescript-api

yarn add @wynnyo/swagger-typescript-api

拷贝文件

拷贝构建文件至项目根目录 文件地址github.com/Curitis/swa…

增加命令

在package.json的scripts中增加命令 gen:api(此处可以不用加命令直接运行也可以,增加命令是为了使用方便) "scripts": { "gen:api": "node swagger-typescript/index.js" }

文件调整

  1. templates/default文件夹下data-contracts.eta里 import { ApiBase } from '@/api-base';中的ApiBase为基类路径自行调整本文对应的文件在github.com/Curitis/swa…
  2. api-base文件中的 axiosInstance为封装后的axiosApiBase里的baseUrl为请求基础路径,请自行调整
  3. index下的generateApi参数需要自行配置,详情看注释

运行获取文件

yarn run gen:api 静静的等待即可

注意事项

如果项目有多个swagger.json可在index在加一个generateApi构建函数注意name和url的调整

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值