由yapi自动生成，可能存在一些例如Header参数缺少，参数不全等错误。
接口调用没有做限制，请不要恶意调用接口。

五子棋代码对战平台

用户接口

注册

基本信息

Path： /sign_up

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
Name string 必须 用户名
UserName string 必须 用户昵称
Password string 必须 密码
Email string 必须 邮箱

返回数据

名称 类型 是否必须 默认值 备注 其他信息

用户代码列表

基本信息

Path： /user_code

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
UserID number 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

登录

基本信息

Path： /sign_in

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
Name string 必须
Password string 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

代码接口

修改代码

基本信息

Path： /code/:ID

Method： PUT

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是 1~87b73933-38f0-11ea-ba05-e86a643dec7c

路径参数

参数名称 示例 备注
ID 1

Body

名称 类型 是否必须 默认值 备注 其他信息
Name string 非必须
Language integer 非必须
Content string 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

新增代码

基本信息

Path： /code

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
Name string 必须
GameID number 必须
Language number 必须
Content string 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

游戏接口

修改游戏信息

基本信息

Path： /game/:ID

Method： PUT

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

路径参数

参数名称 示例 备注
ID 1

Body

名称 类型 是否必须 默认值 备注 其他信息
Name string 非必须
PlayerCount integer 非必须

新增游戏

基本信息

Path： /game

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
Name string 必须
PlayerCount integer 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

游戏列表

基本信息

Path： /game

Method： GET

接口描述：

请求参数

返回数据

名称 类型 是否必须 默认值 备注 其他信息

游戏详情

基本信息

Path： /game/:ID

Method： GET

接口描述：

请求参数

路径参数

参数名称 示例 备注
ID 1 123

新闻通知接口

新增新闻

基本信息

Path： /news

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是

Body

名称 类型 是否必须 默认值 备注 其他信息
Content string 必须
Title string 必须
GameID integer 非必须
ContestID integer 非必须
Global boolean 非必须
Top boolean 非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

比赛接口

参加比赛

基本信息

Path： /contest/:ID/participant

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是

路径参数

参数名称 示例 备注
ID

Body

名称 类型 是否必须 默认值 备注 其他信息
CodeID integer 必须
Index integer 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

新增比赛

基本信息

Path： /contest

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
Name string 必须
GameID integer 必须
BeginTime integer 必须
EndTime integer 必须
SrcContestID integer 非必须 不为空且不为0代表复制scrContest的报名信息

返回数据

名称 类型 是否必须 默认值 备注 其他信息

比赛列表

基本信息

Path： /contest

Method： GET

接口描述：

请求参数

Query

参数名称 是否必须 示例 备注
game_id 是 1

返回数据

名称 类型 是否必须 默认值 备注 其他信息

比赛详情

基本信息

Path： /contest/:ID

Method： GET

接口描述：

请求参数

路径参数

参数名称 示例 备注
ID

对局接口

对局列表

基本信息

Path： /match

Method： GET

接口描述：

请求参数

Query

参数名称 是否必须 示例 备注
game_id 否

返回数据

名称 类型 是否必须 默认值 备注 其他信息

对局详情

基本信息

Path： /match/:ID

Method： GET

接口描述：

请求参数

路径参数

参数名称 示例 备注
ID

新增对局

基本信息

Path： /match

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是

Body

名称 类型 是否必须 默认值 备注 其他信息
GameID integer 必须
Players object [] 必须 item 类型: object
├─ CodeID integer 必须
├─ Index integer 必须
BeginState object 非必须 为空则使用默认初始化状态
├─ MatchID integer 必须
├─ Index integer 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

评测接口

上传评测结果

基本信息

Path： /judge

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称 类型 是否必须 默认值 备注 其他信息
ID integer 必须
Token string 必须
MatchStates object [] 必须 item 类型: object
├─ PlayersScore string 必须
├─ Index integer 必须
├─ Detail string 必须
├─ Status integer 必须
├─ InputData string 必须
├─ OutputData string 必须
├─ TimeUsageNs integer 必须
├─ MemoryUsageBytes integer 必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

获取待评测对局

基本信息

Path： /judge

Method： GET

接口描述：

请求参数

debug接口

debug

基本信息

Path： /debug

Method： GET

接口描述：

请求参数