项目背景

在团队协作开发中，接口文档的维护一直是个痛点。这个平台旨在提供一站式的 API 管理解决方案。

技术架构

1
2
3
4
5
6
7
┌─────────────────────────────────────┐
│            前端 (React)              │
├─────────────────────────────────────┤
│          后端 (NestJS)               │
├─────────────────────────────────────┤
│    数据库 (MongoDB) + 缓存 (Redis)    │
└─────────────────────────────────────┘

功能特性

📝 接口文档

  • 在线编辑接口文档
  • 自动生成请求示例
  • 支持 OpenAPI 导入导出

🧪 接口测试

  • 在线调试接口
  • 环境变量管理
  • 测试用例保存

👥 团队协作

  • 项目成员管理
  • 权限控制
  • 操作日志

🔄 自动化

  • Mock 数据自动生成
  • 接口变更通知
  • 版本对比

技术亮点

  1. WebSocket 实时协作: 多人同时编辑，实时同步
  2. 智能 Mock: 根据字段类型自动生成测试数据
  3. 插件系统: 支持自定义扩展功能

部署方式

支持 Docker 一键部署：

1
docker-compose up -d

后续规划

  • 接口性能监控
  • 自动化测试集成
  • AI 辅助文档生成