Create your Gitee Account

Explore and code with more than 12 million developers，Free private repositories ！：）

This repository doesn't specify license. Please pay attention to the specific project description and its upstream code dependency when using it.

Clone or Download

users.md 4.67 KB

# 用户 API

## 获取用户

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>GET /user/:uid</code></td>
  </tr>
  <tr>
    <th align="right">参数</th>
    <td><code>{ _contentOnly: any; }</code></td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>DataResponse&lt;UserData&gt;</code>)</td>
  </tr>
</table>

## 根据 UID 或名字搜索用户

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>GET /fe/api/user/search</code></td>
  </tr>
  <tr>
    <th align="right">参数</th>
    <td><code>{ keyword: string; }</code></td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{ users: [UserInfo | null]; }</code>)</td>
  </tr>
</table>

## 列出关注

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>GET /fe/api/user/followings</code></td>
  </tr>
  <tr>
    <th align="right">参数</th>
    <td><code>{ user: number; page?: number; }</code></td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{ users: List&lt;User&gt;; }</code>)</td>
  </tr>
</table>

## 列出粉丝

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>GET /fe/api/user/followers</code></td>
  </tr>
  <tr>
    <th align="right">参数</th>
    <td><code>{ user: number; page?: number; }</code></td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{ users: List&lt;User&gt;; }</code>)</td>
  </tr>
</table>

## 获取设置

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>GET /user/setting</code></td>
  </tr>
  <tr>
    <th align="right">参数</th>
    <td><code>{ _contentOnly: any; }</code></td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>DataResponse&lt;UserSettingsData&gt;</code>)</td>
  </tr>
</table>

## 更新设置

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>POST /fe/api/user/updateSetting</code></td>
  </tr>
  <tr>
    <th align="right">请求主体</th>
    <td><code>application/json</code> (<code>{ settings: UserSettings; }</code>)</td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{}</code>)</td>
  </tr>
</table>

## 更新签名

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>POST /fe/api/user/updateSlogan</code></td>
  </tr>
  <tr>
    <th align="right">请求主体</th>
    <td><code>application/json</code> (<code>{ slogan: string; }</code>)</td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{}</code>)</td>
  </tr>
</table>

## 更新介绍

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>POST /fe/api/user/updateIntroduction</code></td>
  </tr>
  <tr>
    <th align="right">请求主体</th>
    <td><code>application/json</code> (<code>{ introduction: string; }</code>)</td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{}</code>)</td>
  </tr>
</table>

## 更新封面

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>POST /fe/api/user/updateHeaderImage</code></td>
  </tr>
  <tr>
    <th align="right">请求主体</th>
    <td><code>application/json</code> (<code>{ imageID: string; }</code>)</td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{}</code>)</td>
  </tr>
</table>

## 绑定 RemoteJudge

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>POST /fe/api/user/bindVjudgeAccount</code></td>
  </tr>
  <tr>
    <th align="right">请求主体</th>
    <td><code>application/json</code> (<code>BindRemoteJudgeAccountRequest</code>)</td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{}</code>)</td>
  </tr>
</table>

## 解除绑定 RemoteJudge

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>POST /fe/api/user/unbindVjudgeAccount</code></td>
  </tr>
  <tr>
    <th align="right">请求主体</th>
    <td><code>application/json</code> (<code>{ oj: string; }</code>)</td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{}</code>)</td>
  </tr>
</table>

## 绑定 OpenID

**注**: 重定向到对应的认证页面。

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>GET /api/openid/connect/:id</code></td>
  </tr>
</table>

## 解除绑定 OpenID

<table>
  <tr>
    <th align="right">请求</th>
    <td><code>POST /fe/api/user/unbindOpenId/:id</code></td>
  </tr>
  <tr>
    <th align="right">响应主体</th>
    <td><code>application/json</code> (<code>{}</code>)</td>
  </tr>
</table>

Copy Edit Raw Blame History

authored 2020-07-07 17:51 . Simplify parameters

用户 API

获取用户

请求	`GET /user/:uid`
参数	`{ _contentOnly: any; }`
响应主体	`application/json` (`DataResponse<UserData>`)

根据 UID 或名字搜索用户

请求	`GET /fe/api/user/search`
参数	`{ keyword: string; }`
响应主体	`application/json` (`{ users: [UserInfo \| null]; }`)

列出关注

请求	`GET /fe/api/user/followings`
参数	`{ user: number; page?: number; }`
响应主体	`application/json` (`{ users: List<User>; }`)

列出粉丝

请求	`GET /fe/api/user/followers`
参数	`{ user: number; page?: number; }`
响应主体	`application/json` (`{ users: List<User>; }`)

获取设置

请求	`GET /user/setting`
参数	`{ _contentOnly: any; }`
响应主体	`application/json` (`DataResponse<UserSettingsData>`)

更新设置

请求	`POST /fe/api/user/updateSetting`
请求主体	`application/json` (`{ settings: UserSettings; }`)
响应主体	`application/json` (`{}`)

更新签名

请求	`POST /fe/api/user/updateSlogan`
请求主体	`application/json` (`{ slogan: string; }`)
响应主体	`application/json` (`{}`)

更新介绍

请求	`POST /fe/api/user/updateIntroduction`
请求主体	`application/json` (`{ introduction: string; }`)
响应主体	`application/json` (`{}`)

更新封面

请求	`POST /fe/api/user/updateHeaderImage`
请求主体	`application/json` (`{ imageID: string; }`)
响应主体	`application/json` (`{}`)

绑定 RemoteJudge

请求	`POST /fe/api/user/bindVjudgeAccount`
请求主体	`application/json` (`BindRemoteJudgeAccountRequest`)
响应主体	`application/json` (`{}`)

解除绑定 RemoteJudge

请求	`POST /fe/api/user/unbindVjudgeAccount`
请求主体	`application/json` (`{ oj: string; }`)
响应主体	`application/json` (`{}`)

绑定 OpenID

注: 重定向到对应的认证页面。

请求	`GET /api/openid/connect/:id`

解除绑定 OpenID

请求	`POST /fe/api/user/unbindOpenId/:id`
响应主体	`application/json` (`{}`)

1

https://gitee.com/tim1103/luogu-api-docs.git

git@gitee.com:tim1103/luogu-api-docs.git

tim1103

luogu-api-docs

luogu-api-docs

master