(编辑:jimmy 日期: 2024/12/24 浏览:2)
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按提示
也可以通过命令行直接传递参数
yo swagger-2-ts --swaggerUrl=http://localhost:8080/swagger-ui.html --className=API --type=typescript --outputFile=api.ts
生成代码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
总结