后端接口文档

后端接口文档

## 一、接口地址

### 1.1 接口基本信息

| 接口名称 | 接口地址 |

| :------: | :------: |

| 用户登录 | http://localhost:3000/api/login |

| 用户注册 | http://localhost:3000/api/register |

| 用户管理 | http://localhost:3000/api/user |

### 1.2 接口描述

#### 1.2.1 用户登录

该接口用于用户登录，实现用户的身份验证。

##### 1.2.1.1 请求方式

该接口支持POST请求方式。

##### 1.2.1.2 请求参数

| 参数名 | 是否必须 | 类型 | 说明 |

| ---------- | -------- | ------ | ------------------------------------------------------------ |

| username | 是 | String | 用户名，用于用户登录验证 |

| password | 是 | String | 用户密码，用于用户登录验证 |

| rememberMe | 否 | Bool | 是否记住用户登录信息，默认为false，不记住用户登录信息，设置为true可记住用户登录信息 |

##### 1.2.1.3 响应参数

| 参数名 | 类型 | 说明 |

| ------ | ------ | ---------------------------- |

| status | Int | 状态码，1表示成功，0表示失败 |

| msg | String | 返回的提示信息 |

#### 1.2.2 用户注册

该接口用于用户注册，实现用户的身份注册。

##### 1.2.2.1 请求方式

该接口支持POST请求方式。

##### 1.2.2.2 请求参数

| 参数名 | 是否必须 | 类型 | 说明 |

| ---------- | -------- | ------ | ---------------- |

| username | 是 | String | 用户名，用于注册 |

| password | 是 | String | 用户密码，用于注册 |

| email | 是 | String | 用户邮箱，用于注册 |

| phone | 是 | String | 用户手机号，用于注册 |

##### 1.2.2.3 响应参数

| 参数名 | 类型 | 说明 |

| ------ | ------ | ---------------------------- |

| status | Int | 状态码，1表示成功，0表示失败 |

| msg | String | 返回的提示信息 |

#### 1.2.3 用户管理

该接口用于用户管理，实现用户的增删改查等操作。

##### 1.2.3.1 请求方式

该接

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。