项目初始化
This commit is contained in:
64
09-后台API说明/用户报名相关接口字段清单.md
Normal file
64
09-后台API说明/用户报名相关接口字段清单.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# 用户报名相关接口字段清单
|
||||
|
||||
## 1. 获取赛事详情
|
||||
- 接口路径:`GET /api/user/events/{eventId}`
|
||||
- 功能说明:获取赛事详情页所需数据。
|
||||
|
||||
### 请求参数
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| eventId | string | 是 | 赛事ID |
|
||||
|
||||
### 返回字段
|
||||
| 字段 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| eventId | string | 赛事ID |
|
||||
| eventName | string | 赛事名称 |
|
||||
| eventCover | string | 封面图 |
|
||||
| eventStatus | string | 赛事状态 |
|
||||
| signupStartTime | string | 报名开始时间 |
|
||||
| signupEndTime | string | 报名截止时间 |
|
||||
| groupList | array | 组别列表 |
|
||||
| location | string | 比赛地点 |
|
||||
| ruleSummary | string | 规则摘要 |
|
||||
| noticeText | string | 参赛须知 |
|
||||
|
||||
## 2. 提交报名
|
||||
- 接口路径:`POST /api/user/signups`
|
||||
- 功能说明:提交报名信息并生成待支付订单。
|
||||
|
||||
### 请求参数
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| eventId | string | 是 | 赛事ID |
|
||||
| groupId | string | 是 | 组别ID |
|
||||
| participantName | string | 是 | 报名人姓名 |
|
||||
| participantPhone | string | 是 | 联系电话 |
|
||||
| gender | string | 否 | 性别 |
|
||||
| birthday | string | 否 | 出生日期 |
|
||||
| remark | string | 否 | 备注 |
|
||||
|
||||
### 返回字段
|
||||
| 字段 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| signupId | string | 报名单ID |
|
||||
| orderId | string | 待支付订单ID |
|
||||
| amount | number | 支付金额 |
|
||||
| payStatus | string | 支付状态 |
|
||||
|
||||
## 3. 查询我的报名列表
|
||||
- 接口路径:`GET /api/user/signups`
|
||||
- 功能说明:获取用户个人报名记录。
|
||||
|
||||
### 查询参数
|
||||
| 字段 | 类型 | 必填 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| page | number | 否 | 页码 |
|
||||
| pageSize | number | 否 | 每页数量 |
|
||||
| signupStatus | string | 否 | 报名状态 |
|
||||
|
||||
### 返回字段
|
||||
| 字段 | 类型 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| list | array | 报名记录列表 |
|
||||
| total | number | 总数 |
|
||||
Reference in New Issue
Block a user