axios+ts自动生成Swagger json告别手写接口

105 阅读2分钟

告别手写接口!基于Swagger json自动生成TypeScript前端代码

背景

在前端开发中,最繁琐的工作之一就是手动编写接口代码。每次后端接口变更,前端都要同步修改类型定义和请求代码,既费时又容易出错。在上家公司,后端同事提供了一个通过Swagger文档自动生成前端代码的工具,让我体验到了"一键生成"的畅快感。

离职后,我决定自己实现一个类似的工具,于是就有了这个auto-ts-api项目。

项目介绍

github项目地址

gitee项目地址

auto-ts-api是一个简单的API代码生成工具,能够从Swagger/OpenAPI JSON文件自动生成TypeScript接口代码,提供类型安全的API调用体验。

主要功能

  • 自动解析Swagger/OpenAPI 3.0.x规范的JSON文件
  • 生成TypeScript接口定义(Models)
  • 生成类型安全的API服务类(Services)
  • 支持基本自定义配置
  • 一键生成,快速使用

快速开始

安装使用

# 安装依赖
npm install

# 确保项目根目录有swagger.json文件
# 运行生成命令
node generate-script.js

📁 项目结构

├── generate-script.js       # 代码生成脚本
├── swagger.json             # Swagger API定义文件
├── package.json             # 项目依赖配置
└── src/
    ├── models/              # 生成的TypeScript接口定义
    │   ├── *.model.ts       # 数据模型文件
    └── services/            # 生成的API服务类
        ├── base.service.ts  # 基础服务类
        └── *.service.ts     # 各模块API服务

实际收益

  1. 提升开发效率:从手动编写接口到一键生成,节省大量时间
  2. 保证类型安全:TypeScript编译时检查,避免字段错误
  3. 降低维护成本:接口变更时只需重新生成代码
  4. 统一代码风格:生成的代码风格一致,便于团队协作

总结

auto-ts-api让前端开发者从繁琐的接口编写工作中解放出来,专注于业务逻辑开发。自从用了自动生成工具,再也不想手写接口了。

如果你也在为接口联调而烦恼,不妨尝试一下这种自动生成的方式,相信你会喜欢上这种高效的工作流程。