API 接口规范文档

1. 文档概述

1.1 文档说明

本文档描述 xxx 系统的 API 接口规范，包括接口地址、请求参数、返回格式等详细信息。

2. 通用说明

2.1 基础URL

开发环境：https://tracking-stage.etowertech.com
测试环境：https://tracking-qa.etowertech.com

2.2 通用请求头

参数

类型

必填

说明

sessionId

String

是

登录会话ID

language

String

是

语言设置

Accept

String

否

期望返回类型：application/json

Content-Type

String

否

请求内容类型：application/json

language 语言取值：

值

说明

zh_CN

简体中文

en_US

英文

2.3 通用响应格式

所有接口统一返回以下格式：

字段

类型

说明

success

Boolean

请求是否成功，true 表示成功

code

String

响应状态码，"0" 表示成功

data

Object/Array

返回的业务数据

errors

Array

错误信息列表，成功时为空数组

成功响应示例：

{
  "success": true,
  "code": "0",
  "data": {...},
  "errors": []
}

失败响应示例：

{
  "success": false,
  "code": "401",
  "data": null,
  "errors": ["会话已过期，请重新登录"]
}

2.4 HTTP 状态码

状态码

说明

200

请求成功

400

请求参数错误

401

未授权，未登录或会话过期

403

禁止访问，无权限

404

资源不存在

500

服务器内部错误