1. 接口基础信息

项目内容
接口名称例如：用户登录接口
请求方式GET / POST / PUT / DELETE 等
请求地址例如：https://api.example.com/login
接口描述简要说明接口功能

2. 请求参数说明

参数名类型必填说明示例
usernameString是用户名“testuser”
passwordString是用户密码（MD5加密）“5f4dcc3b5aa765d61d8327deb882cf99”

3. 请求示例

POST /login HTTP/1.1
Host: api.example.com
Content-Type: application/json

{
  "username": "testuser",
  "password": "5f4dcc3b5aa765d61d8327deb882cf99"
}

4. 返回参数说明

参数名类型说明示例
codeInteger返回状态码，200表示成功200
messageString返回描述信息“登录成功”
tokenString登录成功后返回的令牌“eyJhbGciOiJIUzI1…”

5. 返回示例

{
  "code": 200,
  "message": "登录成功",
  "token": "eyJhbGciOiJIUzI1..."
}

6. 错误码说明

错误码说明处理建议
400请求参数错误检查参数格式和必填项是否正确
401未授权或登录失效重新登录获取token
500服务器内部错误联系后端排查

7. 接口调用注意事项

  • 密码字段需要 MD5 或其他加密传输
  • token 需要放入请求头 Authorization 中以便校验
  • 接口有访问频率限制，避免短时间大量调用导致封禁
  • HTTPS协议请求，确保数据安全

8. 测试工具建议

  • Postman
  • Swagger UI
  • curl 命令行工具

9. 接口迭代记录

版本号修改内容修改时间负责人
v1.0初始版本2024-06-01张三
v1.1增加token字段2024-07-10李四