Skip to content

README.md

Latest commit

 

History

History
277 lines (211 loc) · 10.2 KB

README.md

File metadata and controls

277 lines (211 loc) · 10.2 KB
Raw

📖 API 智能测试平台 文档中心 / Documentation Center

English | 中文

中文文档

📚 文档目录

🚀 快速开始

📦 部署指南

👥 贡献与开发

📖 用户指南

核心功能

  1. API 智能捕获

    • 浏览器录制模式
    • HAR 文件导入
    • mitmproxy 代理模式

  2. API 仓库管理

    • 统一管理所有 API
    • 搜索、筛选和分类
    • 导入功能

  3. 可视化流程编排

    • 拖拽式构建测试流程
    • 变量提取和引用
    • 支持串行和并行执行
    • 定时任务调度
    • 独立环境配置

  4. AI 智能生成测试用例

    • 自然语言描述生成测试
    • 支持多种 AI 提供商
    • 自动生成断言和清理步骤

  5. 测试执行与监控

    • 实时执行监控
    • 详细日志查看
    • 执行历史统计

  6. 平台设置配置

    • 环境配置管理
    • 认证方式配置
    • Session 管理
    • AI 服务配置

🔧 执行器文档

🌐 代理服务器

📷 截图和演示

动图演示
功能截图

中文版截图

英文版截图

🖼️ 品牌资源

💡 使用建议

新手入门路径

  1. 阅读 README 主页 了解项目概述
  2. 按照 Docker 快速部署 部署项目
  3. 配置 平台设置 设置环境和认证
  4. 体验预置测试数据（README 中有详细说明）
  5. 学习 API 仓库管理 了解 API 的组织方式
  6. 学习 可视化流程编排
  7. 尝试 AI 智能生成

进阶用户路径

  1. 学习 API 智能捕获 的三种模式
  2. 掌握 API 仓库管理 的高级功能
  3. 深入理解 测试执行与监控
  4. 掌握 平台设置 的多环境配置
  5. 学习流程编排的 定时任务 和 独立配置
  6. 查看 执行器使用说明 了解底层实现
  7. 参考 完整部署指南 进行生产环境部署

开发者路径

  1. 阅读 贡献指南
  2. 了解项目技术架构（见 README）
  3. 查看执行器和代理服务器的技术文档
  4. 提交 PR 贡献代码

🔗 快速链接

📞 联系我们

English Documentation

📚 Documentation Index

🚀 Getting Started

📦 Deployment Guides

👥 Contributing & Development

📖 User Guides

Core Features

  1. Smart API Capture

    • Browser recording mode
    • HAR file import
    • mitmproxy proxy mode

  2. API Repository Management

    • Centralized API management
    • Search, filter, and categorize
    • Import and export features

  3. Visual Flow Orchestration

    • Drag-and-drop test flow builder
    • Variable extraction and reference
    • Support serial and parallel execution
    • Scheduled task execution
    • Independent environment configuration

  4. AI-Powered Test Generation

    • Generate tests from natural language
    • Support multiple AI providers
    • Auto-generate assertions and cleanup steps

  5. Test Execution & Monitoring

    • Real-time execution monitoring
    • Detailed log viewing
    • Execution history statistics

  6. Platform Settings Configuration

    • Environment configuration management
    • Authentication methods setup
    • Session management
    • AI service configuration

🔧 Executor Documentation

🌐 Proxy Server

📷 Screenshots & Demos

Animated Demos
Feature Screenshots

Chinese Version

English Version

🖼️ Brand Assets

💡 Learning Path

Beginner Path

  1. Read README Home for project overview
  2. Follow Docker Quick Start to deploy
  3. Configure Platform Settings for environment and authentication
  4. Experience pre-loaded test data (detailed in README)
  5. Learn API Repository Management to understand API organization
  6. Learn Visual Flow Orchestration
  7. Try AI-Powered Generation

Advanced User Path

  1. Learn Smart API Capture three modes
  2. Master API Repository Management advanced features
  3. Deep dive into Test Execution & Monitoring
  4. Master Platform Settings for multi-environment configuration
  5. Learn Scheduled Tasks and Independent Configuration in Flow Orchestration
  6. Review Executor Usage Guide for implementation details
  7. Reference Full Deployment Guide for production deployment

Developer Path

  1. Read Contributing Guide
  2. Understand project architecture (see README)
  3. Review executor and proxy server technical docs
  4. Submit PRs to contribute code

🔗 Quick Links

📞 Contact Us

📚 Documentation is continuously updated

如有文档问题或建议，欢迎 提交 Issue

If you have any documentation issues or suggestions, please submit an Issue