apifox-to-axios-ts

介绍

使用 apifox 的接口文档生成 axios 的类型文件

安装教程

1. 首先需要有 apifox 的文档，如果你有其他接口平台的文档，可以将文档导入 apifox

2. 分享接口文档，并复制分享链接

3. 执行终端命令，输入相关配置：

   npx apifox-to-axios-ts init
   ? 请输入 apifox 分享的文档地址或 shareId
   ? 请输入输出目录 src/typings
   ? 请输入文件名 apis.d.ts

4. 创建api文件 (根据自己项目修改)

   // src/api/index.ts
   import _Axios from 'axios'
   import { AxiosStatic } from '../typings/axios'
      
   const Axios = _Axios as AxiosStatic
   const axios = Axios.create()
   axios.get('/xxx/xxx')

   // src/api/index.js
   import _Axios from 'axios'
      
   /** @type { import("../typings/axios").AxiosStatic } */
   const Axios = _Axios
   const axios = Axios.create()
   axios.get('/xxx/xxx')

   在 js 中也能很好工作！

   

5. 更新 apifox 接口文档

   npx apifox-to-axios-ts update