一键生成请求方法的工具 —— OpenAPI Typescript Codegen

文章目录

用法
自定义请求参数的方法
- - 1）使用代码生成器提供的全局参数修改对象
  - [2）直接定义 axios 请求库的全局参数，比如：全局请求响应拦截器](#2）直接定义 axios 请求库的全局参数，比如：全局请求响应拦截器)
报错解决

用法

首先下载axios

shell 复制代码

npm install axios

官网：https://github.com/ferdikoomen/openapi-typescript-codegen

首先安装：

shell 复制代码

npm install openapi-typescript-codegen --save-dev

--input：指定接口文档的路径、url 或字符串内容（必填）

--output：代码生成的目录

--client：生成的代码所需要使用的请求库

shell 复制代码

openapi --input ./spec.json --output ./generated --client xhr

首先复制接口文档的路径

完整路径：http://localhost:8121/api/v2/api-docs

实例代码

shell 复制代码

openapi --input http://localhost:8121/api//v2/api-docs --output ./generated --client axios

执行完成后，在项目根目录中会出现下图目录，可以看见，它直接给我们生成了向后端发请求的函数，当需要使用时，只需要直接调用就好了。

后端把代码写到哪个文件里，生成的请求方法也就会生成到哪个文件里。

如果接口文档发生了变化，只需要再次执行一次上述指令，就可以重新生成了，非常的方便！

自定义请求参数的方法

1）使用代码生成器提供的全局参数修改对象

https://github.com/ferdikoomen/openapi-typescript-codegen/wiki/OpenAPI-object

按如下图寻找

这个配置对象在generated/core里。其中BASE可以修改请求地址

2）直接定义 axios 请求库的全局参数，比如：全局请求响应拦截器

https://www.axios-http.cn/docs/interceptors

src/plugins/axios.ts

ts 复制代码

import axios from 'axios'

// 添加请求拦截器
axios.interceptors.request.use(
  function (config) {
    // 在发送请求之前做些什么
    return config
  },
  function (error) {
    // 对请求错误做些什么
    return Promise.reject(error)
  }
)

// 添加响应拦截器
axios.interceptors.response.use(
  function (response) {
    console.log('响应', responses)

    // 2xx 范围内的状态码都会触发该函数。
    // 对响应数据做点什么
    return response
  },
  function (error) {
    // 超出 2xx 范围的状态码都会触发该函数。
    // 对响应错误做点什么
    return Promise.reject(error)
  }
)

在main.ts中引入

ts 复制代码

import '@/plugins/axios'

报错解决

明明已经执行了安装命令，却还是报错

解决办法

法1：执行以下命令

npx 是一个 Node.js 工具，用于执行安装在项目依赖中的可执行文件。它的作用是在不全局安装的情况下，临时运行项目依赖中的命令。

使用 npx 命令可以避免在全局安装可执行文件时可能出现的版本冲突问题，并且可以确保项目依赖的命令始终是最新版本。

shell 复制代码

npx openapi-typescript-codegen --input http://localhost:8121/api/v2/api-docs --output ./generated --client axios

法2：全局安装

shell 复制代码

npm install openapi-typescript-codegen -g

法3：将目录中的 node_modules/.bin 配置到环境变量中去