json-to-axios

一个用于将 Swagger 自动生成的接口数据转换为 axios 接口的前端脚手架工具。

安装

使用 npm 安装：

npm install --save-dev json-to-axios

配置

在项目根目录下创建一个名为 swagger-to-axios.config.mjs 的配置文件。配置文件内容示例：

export default {
  outputDir: './api', // 生成文件夹
  outputFile: 'axiosInterfaces.js', // 自定义文件命名
  swaggerUrl: 'https://your.swagger.api.url/swagger.json', // Swagger API 文档 URL
  authorization: {
    apiKey: 'your-api-key', // 请求 Swagger 文档所需的权限校验字段
    headerName: 'x-api-key', // 权限校验字段的请求头名称
  },
};

使用方法

在配置文件所在的目录下直接运行 json-to-axios 命令会自动api文件夹

// 在使用的项目中安装 zk-auto-api，添加好配置文件后直接执行
npx json-to-axios

功能

1. 根据 Swagger API 文档生成对应的 axios 接口。
2. 支持 GET、POST、DELETE、PUT 请求方式。
3. 支持 query 和 body 参数。
4. 自动生成的接口函数支持自定义配置。

要求

1. Node.js 12.17.0 或更高版本。
2. 这个 README.md 文件概述了该工具的目的、安装方法、配置和使用方法。你可以根据你的实际项目需求进行调整。

沟通交流

如果再使用中有任何问题欢迎和我沟通交流，后续将继续支持ts版本的，尽请期待

Keywords

axios find-up swagger-parser inquirer