帮我写一份接口测试文档
时间: 2024-01-16 21:04:37 浏览: 76
接口测试文档
好的,以下是接口测试文档。
接口名称:用户登录接口
接口地址:/api/user/login
请求方式:POST
请求参数:
| 参数名 | 类型 | 是否必填 | 说明 |
| -------- | ------ | -------- | -------------- |
| username | string | 是 | 用户名 |
| password | string | 是 | 密码 |
| remember | bool | 否 | 是否记住登录状态 |
请求示例:
```
{
"username": "testUser",
"password": "testPassword",
"remember": true
}
```
响应参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ---------- |
| code | int | 响应状态码 |
| msg | string | 响应信息 |
| data | object | 响应数据 |
响应示例:
```
{
"code": 0,
"msg": "登录成功",
"data": {
"userId": 1001,
"username": "testUser",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}
}
```
接口名称:获取用户信息接口
接口地址:/api/user/info
请求方式:GET
请求参数:无
响应参数:
| 参数名 | 类型 | 说明 |
| ------- | ------ | ---------- |
| code | int | 响应状态码 |
| msg | string | 响应信息 |
| data | object | 响应数据 |
| userId | int | 用户ID |
| username| string | 用户名 |
| avatar | string | 用户头像 |
| email | string | 用户邮箱 |
请求示例:无
响应示例:
```
{
"code": 0,
"msg": "获取用户信息成功",
"data": {
"userId": 1001,
"username": "testUser",
"avatar": "https://avatar.com/testUser.png",
"email": "testUser@example.com"
}
}
```
以上为接口测试文档,如有疑问请联系开发人员。
阅读全文