api markdown 模版

时间:2021-10-13 00:37:56

模板效果

简要描述:

  • 用户登录

接口版本:

版本号 制定人 制定日期 修订日期
1.0 梁云亮 2022-11-3 07:43
1.1 张三 2022-11-4 09:23

权限

  • 所有 API Key 都可以调用本 API

请求URL:

  • /user/login

请求方式:

  • POST

Header

参数名 是否必须 类型 说明
Content-Type string 请求类型: application/json
Content-MD5 string 请求内容签名

请求参数:

参数名 是否必须 类型 说明
username string 用户名
password string 密码

调用示例:

{
"username":"369950806@qq.com",
"password":"1234"
}

返回示例:

正确时返回:

{
	"msg":"登录成功",
	"code":"200",
	"data":{
		"role":1001,
		"phone":"13264494458",
		"nickname":"张三",
		"id":1585103349332148226,
		"email":"369950806@qq.com",
		"username":"zhangsan"
	}
}

错误时返回:

{
	"msg":"用户名或密码错误",
	"code":401
}

返回参数说明:

参数名 类型 说明
code int 状态码
msg string 结果描述信息
data string 结果数据

备注:

  • 更多返回错误代码请看首页的错误代码描述

源码

### 简要描述:

- 用户登录

### 接口版本:

|版本号|制定人|制定日期|修订日期|
|:---- |:------ |:-------- |------- |
|1.0 |梁云亮|2022-11-3 07:43 | |
|1.1 |张三|2022-11-4 09:23 | |

### 权限

- 所有 API Key 都可以调用本 API

### 请求URL:

- /user/login

### 请求方式:

- POST

### Header
|参数名|是否必须|类型|说明|
|:---- |:---|:----- |----- |
|Content-Type |是 |string |请求类型:  application/json |
|Content-MD5|是|string|请求内容签名|

### 请求参数:

|参数名|是否必须|类型|说明|
|:---- |:---|:----- |----- |
|username |是 |string | 用户名 |
|password|是|string|密码|


### 调用示例:
```json
{
"username":"369950806@qq.com",
"password":"1234"
}
```

### 返回示例:

**正确时返回:**

```json
{
	"msg":"登录成功",
	"code":"200",
	"data":{
		"role":1001,
		"phone":"13264494458",
		"nickname":"张三",
		"id":1585103349332148226,
		"email":"369950806@qq.com",
		"username":"zhangsan"
	}
}
```

**错误时返回:**

```json
{
	"msg":"用户名或密码错误",
	"code":401
}
```

### 返回参数说明:

|参数名|类型|说明|
|:----- |:-----|----- |
|code|int|状态码|
|msg|string|结果描述信息|
|data|string|结果数据|


### 备注:
- 更多返回错误代码请看首页的错误代码描述