跳到主要内容

API 包

API 包提供统一的 API 接口管理，包括请求封装、响应处理、错误处理等功能。

功能特性​

请求管理​

  • 统一请求封装
  • 请求拦截器
  • 响应拦截器
  • 错误处理

接口管理​

  • 接口定义
  • 参数验证
  • 响应转换
  • 缓存管理

类型安全​

  • TypeScript 类型
  • 接口类型定义
  • 响应类型定义
  • 错误类型定义

开发指南​

安装使用​

# 在应用中安装
pnpm add @jingyun/api

# 在组件中使用
import { api } from '@jingyun/api'

配置设置​

// 配置 API
api.config({
  baseURL: 'https://api.example.com',
  timeout: 10000,
  headers: {
    'Content-Type': 'application/json'
  }
})

项目结构​

packages/api/
├── src/
│   ├── types/          # 类型定义
│   ├── modules/        # 接口模块
│   ├── interceptors/   # 拦截器
│   ├── utils/          # 工具函数
│   ├── config.ts       # 配置文件
│   └── index.ts        # 入口文件
├── tests/              # 测试文件
└── package.json        # 包配置

API 模块​

用户模块​

  • user.login(): 用户登录
  • user.logout(): 用户登出
  • user.getInfo(): 获取用户信息
  • user.update(): 更新用户信息

业务模块​

  • agent.list(): 智能体列表
  • agent.create(): 创建智能体
  • agent.update(): 更新智能体
  • agent.delete(): 删除智能体

系统模块​

  • system.config(): 系统配置
  • system.menu(): 菜单列表
  • system.dict(): 字典数据
  • system.upload(): 文件上传

拦截器​

请求拦截器​

  • 添加认证信息
  • 参数序列化
  • 请求日志
  • 错误预处理

响应拦截器​

  • 统一响应处理
  • 错误处理
  • 数据转换
  • 缓存处理

错误处理​

错误类型​

  • 网络错误
  • 服务器错误
  • 业务错误
  • 认证错误

错误处理策略​

  • 自动重试
  • 错误上报
  • 用户提示
  • 降级处理

开发规范​

接口定义​

  • RESTful 规范
  • 统一响应格式
  • 参数验证
  • 文档注释

类型定义​

  • 接口类型
  • 参数类型
  • 响应类型
  • 错误类型

测试策略​

单元测试​

  • 接口测试
  • 工具函数测试
  • 错误处理测试
  • 类型测试

集成测试​

  • API 集成测试
  • 错误场景测试
  • 性能测试
  • 兼容性测试