Vue 使用typescript如何优雅的调用swagger API

网络编程 2024/12/27 佚名

3 2 1

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

前端如何优雅的调用呢？

入门版

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

// 应用管理相关接口
import axios from '../interceptors.js'

// 获取应用列表
export const getList = (data) => {
 return axios({
 url: '/app/list"external nofollow" href="https://www.npmjs.com/package/generator-swagger-2-ts">generator-swagger-2-t, 简单的实现了将swagger生成typescript api。
今天，笔者对这个做了升级，方便支持后端返回的泛型数据结构。
安装
需要同时安装 Yeoman 和 -swagger-2-ts


npm install -g generator-swagger-2-ts


然后cd到你的工作目录，执行:


yo swagger-2-ts


按提示

  输入swagger-ui 地址，例如http://192.168.86.8:8051/swagger-ui.html
  可选生成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 AccountUserInfo = {
 disableTime"htmlcode">

import { API } from './http/api/manageApi'
// in main.ts
let api = new API("/api/")
api.getUserAccountAPI().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
  .getUserAccountAPI().changeUserState({isDisable: 1， openId: 'open id'})


开源地址
https://github.com/jadepeng/generator-swagger-2-ts
总结