API 接口文档

ADS-Wise 管理平台 RESTful API 接口文档

API 概览

基础URL

所有API请求的基础地址

http://localhost:3000

响应格式

所有API都返回统一的JSON格式

{
  "code": 200,
  "msg": "Success",
  "data": { ... }
}

状态码

  • • 200: 成功
  • • 400: 客户端错误
  • • 404: 资源不存在
  • • 500: 服务器错误
接口统计
17
总接口数
5
模块数
9
GET接口
8
POST/PUT/DELETE
快速开始

1. 检查系统状态

curl -X GET "http://localhost:3000/api/system/health"

2. 初始化数据库(如需要)

curl -X POST "http://localhost:3000/api/system/init"

3. 获取全局参数

curl -X GET "http://localhost:3000/api/settings"
测试工具
推荐的API测试工具和资源

Bash脚本测试

使用提供的bash脚本进行完整API测试

chmod +x scripts/test-apis.sh && ./scripts/test-apis.sh

Python自动化测试

使用Python脚本进行API验证测试

pip install requests && python scripts/test_api_validation.py

Postman集合

导入Postman集合进行交互式测试