# User - 用户

> url 前缀：**user**
>
> 示例：**https://xxxxxxxxx/api/user/xxxx**

## 创建用户

`ADMIN`

```http
post
```

### Parameters

```ts
interface UserDTO {
  username: string;
  email: string;
  role: UserRole;
  phone: string;
}
```

### Response

```ts
interface UserData {
  err: 0;
  res: UserSerializer;
}
```

see [UserSerializer](../serializer/UserSerializer.md)

## 获得用户列表

`ADMIN`

```http
get
```

### Parameters

| Name   | Type   | Description |
| ------ | ------ | ----------- |
| page   | number | 页码        |
| limit  | number | 每页条数    |
| search | string | 搜索信息    |

### Response

```ts
interface UserPageData {
  err: 0;
  res: Array<UserSerializer>;
  page: PageSerializer;
}
```

see [UserSerializer](../serializer/UserSerializer.md), [PageSerializer](../serializer/PageSerializer.md)

## 查看用户

`ADMIN`

```http
get /:userId
```

### Response

```ts
interface UserData {
  err: 0;
  res: UserSerializer;
}
```

see [UserSerializer](../serializer/UserSerializer.md)

## 删除用户

`ADMIN`

```http
delete /:userId
```

### Response

```ts
interface EmptyData {
  err: 0;
}
```

## 重置密码

`ADMIN`

```http
post /:userId/password/change
```

### Response

```ts
interface EmptyData {
  err: 0;
}
```

## 查看用户的考试结果列表

`STUDENT` `ADMIN`

<!-- TODO: bad design -->

```http
get /:userId/result
```

### Response

```ts
interface ProblemPageData {
  err: 0;
  res: Array<ProblemSerializer>;
}
```

see [ProblemSerializer](../serializer/ProblemSerializer.md)