You need to sign in or sign up before continuing.
QUICKSTART_APIFOX.md 1.76 KB

🚀 Apifox 集成快速开始

第一步:获取 Apifox 凭证

1.1 获取 API Token

  1. 访问 Apifox 并登录
  2. 点击右上角头像 → 个人设置
  3. 选择 API Token新建 Token
  4. 输入名称(如"Manulife WeApp")
  5. 复制生成的 Token(格式:aps-xxxxx

1.2 获取项目 ID

在 Apifox 中打开您的项目,URL 格式为:

https://app.apifox.com/project/{PROJECT_ID}/...

复制 {PROJECT_ID} 部分。

第二步:配置项目

2.1 创建配置文件

在项目根目录执行:

cp .env.apifox.example .env.apifox

2.2 填写凭证信息

编辑 .env.apifox 文件:

# 替换为你的实际值
VITE_APIFOX_TOKEN=aps-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
VITE_APIFOX_PROJECT_ID=12345678

第三步:同步 API

运行同步命令:

pnpm api:sync

这个命令会:

  1. ✅ 从 Apifox 获取所有接口
  2. ✅ 生成 OpenAPI 文档到 docs/api-specs/
  3. ✅ 生成 API 代码到 src/api/

第四步:使用 API

在组件中导入并使用:

import { getUserInfoAPI } from '@/api/user'

// 调用 API
const res = await getUserInfoAPI({ userId: '123' })
if (res.code === 1) {
  console.log('用户信息:', res.data)
}

📚 更多信息

详细文档请查看:Apifox 集成完整指南

❓ 常见问题

Q: 提示"未找到 .env.apifox 文件"

# 解决方案:创建配置文件
cp .env.apifox.example .env.apifox

Q: 提示"HTTP 401"

  • 检查 API Token 是否正确
  • 确认 Token 未过期

Q: 提示"项目不存在"

  • 检查项目 ID 是否正确
  • 确认账号有项目访问权限

需要帮助? 查看完整文档或联系项目组