1 Star 0 Fork 0

fixedx / apifox-to-typescript

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

@fixedx/apifox-to-typescript

将ApiFox的接口转换为TypeScript接口

使用方法

1. 安装依赖

# 使用npm
npm install @fixedx/apifox-to-typescript

# 使用yarn
yarn add @fixedx/apifox-to-typescript

# 使用pnpm
pnpm install @fixedx/apifox-to-typescript

2. 创建配置文件

在项目根目录下的package.json配置以下内容:

// package.json
// ... 
"apifox": {
    "auth": {
      "account": "youraccount",
      "password": "yourpassword"
    },
    "projectId": "yourproject",
    "output": "src/apis", // 接口输出目录
    "requestMethodPath": "@/utils/request" // 请求方法目录, 需自行提供
}
// ...

3. 命令介绍

  • att create 命令

根据配置文件中的信息,从ApiFox获取接口信息,并生成对应的TypeScript接口文件。

npx att create
  • att lock命令

重新生成api.lock.json文件,用于锁定接口文件名。

npx att lock

空文件

简介

将apifox定义的接口转换成typescript类型定义 展开 收起
JavaScript 等 2 种语言
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/fixedx/apifox-to-typescript.git
git@gitee.com:fixedx/apifox-to-typescript.git
fixedx
apifox-to-typescript
apifox-to-typescript
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891