markdown接口模版.md

[TOC]



## 1. 用户接口

与用户相关接口。

### 1.1 添加用户

添加用户

#### request

```HTTP
POST /api/v1/users HTTP/1.1

{
    "loginId":"admin",
    "userName":"123456",
    "passwords":"123456"
}
```

##### header

| Field    | Type   | Condition | Default | Description |
| :------- | :----- | :-------- | :------ | :---------- |
| loginId  | String |           |         | 用户编号    |
| userName | String |           |         | 用户名      |
| password | String |           |         | 密码        |

##### query

| Field    | Type   | Condition | Default | Description |
| :------- | :----- | :-------- | :------ | :---------- |
| loginId  | String |           |         | 用户编号    |
| userName | String |           |         | 用户名      |
| password | String |           |         | 密码        |

##### body

| Field    | Type   | Condition | Default | Description |
| :------- | :----- | :-------- | :------ | :---------- |
| loginId  | String |           |         | 用户编号    |
| userName | String |           |         | 用户名      |
| password | String |           |         | 密码        |

#### response

```
{
    "loginId":"admin",
    "userName":"123456",
    "passwords":"123456"
}
```

| Field    | Type   | Description |
| :------- | :----- | :---------- |
| loginId  | String | 用户编号    |
| userName | String | 用户名      |
| password | String | 密码        |