vue 根据swagger 生成接口_Vue 使用typescript, 优雅的调用swagger API

本文介绍了如何利用Swagger的JSON Schema在Vue中自动生成接口代码,结合typescript增强类型约束。通过generator-swagger-2-ts插件,可以自动化生成API类,简化前端调用RESTful接口的过程。在Vue项目中,全局注入API实例,提供智能提示,实现优雅的接口调用。
摘要由CSDN通过智能技术生成

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,后端集成下Swagger,然后就可以提供一个在线文档地址给前端同学。

前端如何优雅的调用呢?

入门版

根据文档,用axios自动来调用

// 应用管理相关接口

import axios from '../interceptors.js'

// 获取应用列表

export const getList = (data) => {

return axios({

url: '/app/list?sort=createdDate,desc',

method: 'get',

params: data

})

}

这里的问题是,有多少个接口,你就要编写多少个函数,且数据结构需要查看文档获取。

进阶版本

使用typescript,编写API,通过Type定义数据结构,进行约束。

问题: 还是需要手写

优雅版本

swagger 其实是一个json-schema描述文档,我们可以基于此,自动生成。

很早之前,写过一个插件 generator-swagger-2-t, 简单的实现了将swagger生成typescript api。

今天,笔者对这个做了升级,方便支持后端返回的泛型数据结构。

安装

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值