API.md

代码翻译系统 API 文档

本文档详细说明了代码翻译系统提供的所有API接口，包括请求方法、URL、参数和响应格式。

目录

基础信息接口

健康检查

检查API服务是否正常运行。

• URL: /api/health
• 方法: GET
• 参数: 无

成功响应:

{
  "status": "ok",
  "message": "代码翻译服务正常运行"
}

以下是基于当前功能的API文档规范，按照您提供的格式编写：

文件级分析

上传并分析CSV数据文件，支持多维度分析。

• URL: /api/upload
• 方法: POST
• 内容类型: multipart/form-data

请求参数:

参数名	类型	必填	描述
file	file	是	待分析的CSV数据文件
dimensions	array[string]	是	需要分析的维度列表（至少一个）

成功响应 (即时分析):

{
  "status": "success",
  "dimensions_count": 3,
  "timestamp": "2024-03-20T15:30:00Z",
  "results": {
    "age": {
      "statistics": {"mean": 35.2, "median": 33},
      "analysis": {"top_values": {"30":50}, "unique_count":20}
    },
    "income": {
      "statistics": {"mean":55000, "median":50000},
      "analysis": {"top_values": {"50000":30}, "unique_count":15}
    }
  }
}

错误响应:

{
  "status": "error",
  "message": "文件类型不支持（仅允许CSV文件）"
}

状态码:

• 200 OK: 成功返回分析结果
• 400 Bad Request: 参数缺失或无效
• 415 Unsupported Media Type: 文件类型错误
• 500 Internal Server Error: 服务器处理失败

---

附加说明

1. 维度参数传递支持两种方式：
   • 多参数形式：dimensions=age&dimensions=income
   • 逗号分隔形式：dimensions=age,income