Vue 使用typescript如何优雅的调用swagger API
网络编程 2021-07-04 14:06www.168986.cn编程入门
这篇文章主要介绍了Vue 使用typescript如何优雅的调用swagger API,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
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描述文档,我们可以基于此,自动生成。
很早之前,写过一个插件 , 简单的实现了将swagger生成typescript api。
今天,笔者对这个做了升级,方便支持后端返回的泛型数据结构。
安装
需要安装 和 -swagger-2-ts
npm install -g generator-swagger-2-ts
然后cd到你的工作目录,执行:
yo swagger-2-ts
按提示
- 输入swagger-ui 地址,例如
- 可选生成js 或者 typescript
- 可以自定义生成的api class名称、api文件名
- API 支持泛型
也可以通过命令行直接传递参数
yo swagger-2-ts --swaggerUrl=http://localhost:8080/swagger-ui.html --className=API --type=typescript --outputFile=api.ts
- swaggerUrl: swagger ui url swaggerui地址
- className API class name 类名
- type typescript or javascipt
- outputFile: api 文件保存路径
生成代码demo
export type AountUserInfo = { disableTime?: string isDisable?: number lastLoginIp?: string lastLoginPlace?: string lastLoginTime?: string openId?: string } export type BasePayloadResponse = { data?: object desc?: string retcode?: string } / User Aount Controller @class UserAountAPI / export class UserAountAPI { / changeUserState @method @name UserAountAPI#changeUserState @param aountUserInfo - aountUserInfo @param $domain API域名,没有指定则使用构造函数指定的 / changeUserState(parameters: { 'aountUserInfo': AountUserInfo, $queryParameters?: any, $domain?: string }): Promise<AxiosResponse<BasePayloadResponse>> { let config: AxiosRequestConfig = { baseURL: parameters.$domain || this.$defaultDomain, url: '/userAount/changeUserState', method: 'PUT' } config.headers = {} config.params = {} config.headers[ 'Aept' ] = '/' config.headers[ 'Content-Type' ] = 'application/json' config.data = parameters.aountUserInfo return axios.request(config) } _UserAountAPI: UserAountAPI = null; / 获取 User Aount Controller API return @class UserAountAPI / getUserAountAPI(): UserAountAPI { if (!this._UserAountAPI) { this._UserAountAPI = new UserAountAPI(this.$defaultDomain) } return this._UserAountAPI } } / 管理系统接口描述 @class API / export class API { / API构造函数 @param domain API域名 / constructor(domain?: string) { this.$defaultDomain = domain || 'http://localhost:8080' } }
使用
import { API } from './http/api/manageApi' // in main.ts let api = new API("/api/") api.getUserAountAPI().changeUserState({ isDisable: 1 openId: 'open id' })
Vue中最佳实践
main.ts 全局定义
import { API } from './http/api/manageApi' Vue.prototype.$manageApi = new API('/api/')
增加.d.ts
增加types文件,方便使用智能提示
import { API } from '@/http/api/manageApi' import { MarkAPI } from '@/http/api/mark-center-api' declare module "vue/types/vue" { interface Vue { $manageApi: API $markApi: MarkAPI } }
实际使用
现在可以在vue里直接调用了。
this.$manageApi .getUserAountAPI().changeUserState({isDisable: 1, openId: 'open id'})
开源地址
到此这篇关于Vue 使用typescript如何优雅的调用swagger API的文章就介绍到这了,更多相关Vue 使用typescript内容请搜索狼蚁SEO以前的文章或继续浏览狼蚁网站SEO优化的相关文章希望大家以后多多支持狼蚁SEO!
编程语言
- 如何快速学会编程 如何快速学会ug编程
- 免费学编程的app 推荐12个免费学编程的好网站
- 电脑怎么编程:电脑怎么编程网咯游戏菜单图标
- 如何写代码新手教学 如何写代码新手教学手机
- 基础编程入门教程视频 基础编程入门教程视频华
- 编程演示:编程演示浦丰投针过程
- 乐高编程加盟 乐高积木编程加盟
- 跟我学plc编程 plc编程自学入门视频教程
- ug编程成航林总 ug编程实战视频
- 孩子学编程的好处和坏处
- 初学者学编程该从哪里开始 新手学编程从哪里入
- 慢走丝编程 慢走丝编程难学吗
- 国内十强少儿编程机构 中国少儿编程机构十强有
- 成人计算机速成培训班 成人计算机速成培训班办
- 孩子学编程网上课程哪家好 儿童学编程比较好的
- 代码编程教学入门软件 代码编程教程