跑鸭

公共信息

跑鸭

接口说明

通常没有特殊说明，接口的传参均采用json格式
通常接口返回数据格式为：

{
  'isSuccess': true,
  'msg': '操作成功',
  'data': {}
}

数据长度说明

经纬度：整数最多3位，小数最多15位；
速度：整数最多2位，小数最多2位；
里程：整数最多3位，小数最多2位；
其余整数：最多10位（有的默认是11位）

环境说明

开发环境：开发时使用，主要提供给前端开发。开发环境可用的接口tag：已部署

# 每个小时自动部署跑鸭后端
00 * * * * cd /home/dev.run/PopRun-b/ && git pull origin master

正式环境：正式用于毕业设计答辩演示的环境，这里面的数据必须得录入比较正式些（暂未部署）
后端本地环境：主要提供给后端开发测试使用，是后端本地的

tag设置：

未设置：还在开发中
已部署：已同步至开发环境，前端可用
已上线：同步至正式环境，测试和演示可用（前端也可用）
暂不实现：因种种原因，暂不实现或后期实现

E-R

全局接口 api/main/

上传图片

基本信息

Path： /api/main/uploadImg

Method： POST

接口描述：

注意：此传输格式为form

后端代码： https://github.com/Chef5/PopRun-b/commit/672abb3c6e25413d0a2eb80af16ade513d3998fe

返回示例：

{
    "isSuccess": true,
    "msg": "上传成功",
    "data": {
        "name": "微信图片_20190507214403.jpg",
        "store": "5e3858831fa42",
        "extension": "jpg",
        "mimetype": "image/jpeg",
        "size": 149155,
        "width": 1080,
        "height": 1920,
        "mwidth": 200,
        "mheight": 356,
        "original": "http://dev.run.nunet.cn/resources/images/2020-02-04/5e3858831fa42-1080x1920.jpg",
        "thumbnail": "http://dev.run.nunet.cn/resources/images/2020-02-04/5e3858831fa42-min-200x356.jpg",
        "error": 0
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
img	file	是

返回数据

名称	类型	是否必须	备注
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ name	string	非必须	原名称
├─ store	string	非必须	存储名称
├─ extension	string	非必须	后缀
├─ mimetype	string	非必须	格式
├─ size	number	非必须	原文件大小
├─ width	number	非必须	原宽
├─ height	number	非必须	原高
├─ mwidth	number	非必须	缩略图宽
├─ mheight	number	非必须	缩略图高
├─ original	string	非必须	原图地址
├─ thumbnail	string	非必须	缩略图地址
├─ error	number	非必须	上传错误

删除通知

基本信息

Path： /api/main/delNotice

Method： POST

接口描述：

阅读通知时，以数组形式传递noid，可以进行批量删除操作。

后端代码：https://github.com/Chef5/PopRun-b/commit/6843a79cd720806ed3e1e532ead9f20398a43f7c

请求示例：

{
  "noids": [
    2,3
  ]
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": "操作成功"
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
noids	integer []	必须			item 类型: integer
├─		非必须		noid

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	string	非必须

用户授权注册

基本信息

Path： /api/main/wxAuth

Method： POST

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/338badd7a8a126b1e1007169643fce6ac64e5c5a
优化记录（返回值为getUserAll）：https://github.com/Chef5/PopRun/commit/b0cdfd67b862e05bd0690500bcc7b1778e20b0da
优化记录（初始化隐私设置）：https://github.com/Chef5/PopRun-b/commit/8e6b971c6d66c2bcc63e3b0e716415ae5c2caf26

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": 9,
    "openid": "oZoB85ZonTk33GQC4iWxlsbh06UI",
    "nickname": "しiuyam",
    "team": null,
    "sex": "2",
    "img": "https://wx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLtLfzx8n8Xaswx5ebF522FgV7VE1FIMXiaPQ5B3WK9oQliabhMWgliaOhuNsXibNSP36uu3AouE91T3g/132",
    "info": null,
    "job": null,
    "created_at": "2020-03-11 19:57:21",
    "updated_at": "2020-03-11 19:57:21",
    "honors": {
      "rid": 9,
      "hoid": 2,
      "created_at": "2020-03-30 14:32:50",
      "updated_at": "2020-03-30 14:32:52",
      "desc": "lv1",
      "name": "草鞋"
    },
    "medals": [
      {
        "linkid": 1,
        "rid": 9,
        "meid": 3,
        "created_at": "2020-03-30 14:40:30",
        "updated_at": "2020-03-30 14:40:32",
        "mkey": "star_3_act",
        "type": 0,
        "name": "3星跑者",
        "desc": "单次运动里程达15km",
        "img": "http://dev.run.nunet.cn/resources/medals/star_3_act.png"
      },
      {
        "linkid": 9,
        "rid": 9,
        "meid": 28,
        "created_at": "2020-03-30 14:42:29",
        "updated_at": "2020-03-30 14:42:31",
        "mkey": "rank_d",
        "type": 1,
        "name": "钻石",
        "desc": "您在上月累计里程在全国前100名，授予您一枚钻石勋章",
        "img": "http://dev.run.nunet.cn/resources/medals/rank_d.png"
      }
    ]
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
openid	string	必须	用户openid
nickname	string	必须	微信昵称
sex	string	必须	性别
img	string	必须	微信头像

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ openid	string	非必须
├─ nickname	string	非必须
├─ team	null	非必须
├─ sex	string	非必须
├─ img	string	非必须
├─ info	null	非必须
├─ job	null	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ honors	object	非必须
├─ rid	number	非必须
├─ hoid	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ desc	string	非必须
├─ name	string	非必须
├─ medals	object []	非必须	item 类型: object
├─ linkid	number	必须
├─ rid	number	必须
├─ meid	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ mkey	string	必须
├─ type	number	必须
├─ name	string	必须
├─ desc	string	必须
├─ img	string	必须

获取openid

基本信息

Path： /api/main/getOpenid

Method： POST

接口描述：

用户授权注册过程中需要先获取openid
后端代码：https://github.com/Chef5/PopRun-b/commit/df02bc8193474edf0d895729f1282ad038fd5285

返回示例：

{
    "isSuccess":true,
    "msg":"\u64cd\u4f5c\u6210\u529f",
    "data":{
        "session_key":"sGi0yZ3k1FFi72jB24j+3g==",
        "openid":"oZoB85aH7YMonlIiTPJS4hUqWntU"
    }
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须		微信登录临时码

返回数据

名称	类型	是否必须	备注
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ session_key	string	非必须	登录session
├─ openid	string	非必须	openid

获取token（后期加）

基本信息

Path： /api/main/getToken

Method： GET

接口描述：

token是用户唯一的认证方式，除公用获取类接口（不需要任何传参的）外，其他任何与用户数据操作相关的均需要携带token
若第一次登陆或者本地无token时，token值可以是 ""、"undefined"、"null"等

请求参数

返回数据

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

获取勋章列表

基本信息

Path： /api/main/getMedalAll

Method： GET

接口描述：

勋章列表：
单次里程成就：5km,10km,15km,20km,半马,全马,50km,100km (star_1_act.png star_1.png)

月成就（月累计跑步达七次）：月牌（2020.01等）(2020-01.png)

季成就（3个月内，跑步次数达到45次）：季牌（2020春等）(春2020-a.png)

区域累计里程成就（月榜）：校区前100（rank_1.png），校区前10（rank_2.png），校前1（rank_3.png），国前100（rank_4.png）

活动成就（完成活动即可获得）：一次获得

后端代码：https://github.com/Chef5/PopRun-b/commit/01efaf5d89cd68fada577be9dd989df8ec8eb7c8

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "meid": 1,
      "mkey": "star_1_act",
      "type": 0,
      "desc": "单次运动里程达5km",
      "name": "1星跑者",
      "img": "http://127.0.0.1:8000/resources/medals/star_1_act.png",
      "created_at": "2020-03-21 14:32:31",
      "updated_at": "2020-03-21 14:32:31"
    }
  ]
}

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须		item 类型: object
├─ meid	number	必须	id
├─ mkey	string	必须	检索关键词
├─ type	number	必须	类型：0不可重复获得，1可重复获得
├─ desc	string	必须	描述文字
├─ name	string	必须	勋章名
├─ img	string	必须	勋章图标
├─ created_at	string	必须
├─ updated_at	string	必须

获取称号列表

基本信息

Path： /api/main/getHonorAll

Method： GET

接口描述：

称号（用户等级）列表：

赤脚
草鞋
棉鞋
布鞋
板鞋
高跟鞋
球鞋
运动鞋
跑鞋

根据用户性别，分别在称号列表后面加汉子和妹子，如性别1（男性）：草鞋汉子，性别2（女性）：草鞋妹子，性别0（未知）不添加
后端代码：https://github.com/Chef5/PopRun-b/commit/19d59ca320cba7e3660d4f6a429844a1944173e6

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "name": "赤脚",
      "desc": "lv0"
    },
    {
      "name": "草鞋",
      "desc": "lv1"
    },
    {
      "name": "棉鞋",
      "desc": "lv2"
    },
    {
      "name": "布鞋",
      "desc": "lv3"
    },
    {
      "name": "板鞋",
      "desc": "lv4"
    },
    {
      "name": "高跟鞋",
      "desc": "lv5"
    },
    {
      "name": "球鞋",
      "desc": "lv6"
    },
    {
      "name": "运动鞋",
      "desc": "lv7"
    },
    {
      "name": "跑鞋",
      "desc": "lv8"
    }
  ]
}

请求参数

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须	mock: @boolean
msg	string	非必须	mock: @cword(4)
data	object []	非必须	item 类型: object
├─ name	string	必须	mock: @city
├─ desc	string	必须	mock: @sentence

获取系统通知

基本信息

Path： /api/main/getNotice

Method： POST

接口描述：

主要用于tab的红点和数字显示、消息查看
后端代码：https://github.com/Chef5/PopRun-b/commit/1fd6df0bea10fe634b512eed3fb3be8d6f250cb3

请求示例：

{
    "rid": 2
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "noid": 1,
      "from": 5,
      "to": 2,
      "type": 1,
      "read": 0,
      "msg": "收到来自 [Chef5] 的点赞！",
      "created_at": "2020-04-16 19:06:50",
      "updated_at": "2020-04-16 19:06:50"
    },
    {
      "noid": 2,
      "from": 5,
      "to": 2,
      "type": 2,
      "read": 0,
      "msg": "[Chef5] 评论：fugiat ad et in do",
      "created_at": "2020-04-16 19:23:35",
      "updated_at": "2020-04-16 19:23:35"
    }
  ]
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
rid	integer	必须	当前用户id
type	integer	非必须	不填获取全部类型！1点赞，2评论，0系统通知
read	integer	非必须	不填获取全部状态！0未读，1已读

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须		item 类型: object
├─ noid	number	必须
├─ from	number	必须	发出者：0代表系统
├─ to	number	必须	接收者
├─ type	number	必须
├─ read	number	必须	是否已读
├─ msg	string	必须	消息内容
├─ created_at	string	必须
├─ updated_at	string	必须

阅读通知

基本信息

Path： /api/main/readNotice

Method： POST

接口描述：

阅读通知时，以数组形式传递noid，可以进行批量阅读操作。

后端代码：https://github.com/Chef5/PopRun-b/commit/3c197672d527b9f7731df96c110333031952af8d

请求示例：

{
  "noids": [
    2,3
  ]
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "noid": 2,
      "from": 5,
      "to": 2,
      "type": 2,
      "read": 1,
      "msg": "[Chef5] 评论：fugiat ad et in do",
      "created_at": "2020-04-16 19:23:35",
      "updated_at": "2020-04-17 08:50:40"
    },
    {
      "noid": 3,
      "from": 5,
      "to": 2,
      "type": 0,
      "read": 1,
      "msg": "系统通知",
      "created_at": "2020-04-17 08:40:07",
      "updated_at": "2020-04-17 08:50:40"
    }
  ]
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
noids	integer []	必须			item 类型: integer
├─		非必须		noid

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须	item 类型: object
├─ noid	number	非必须
├─ from	number	非必须
├─ to	number	非必须
├─ type	number	非必须
├─ read	number	非必须
├─ msg	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

动态圈子 api/moments/

基本信息

Path： /api/moments/doLike

Method： POST

接口描述：

点赞后取消点赞主要在前端处理，不用通过判断返回值判断是否成功
后端代码：https://github.com/Chef5/PopRun-b/commit/d67fb229dd9f1a1afa224697e7515ebd4815ce80

请求示例：

{
  "rid": 27,
  "moid": 11
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": 27,
    "moid": 22,
    "updated_at": "2020-02-03 14:44:09",
    "created_at": "2020-02-03 14:44:09",
    "id": 0
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
rid	number	必须		点赞人
moid	number	必须		点赞动态

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ moid	number	非必须
├─ updated_at	string	非必须
├─ created_at	string	非必须
├─ id	number	非必须

删除动态

基本信息

Path： /api/moments/delMoment

Method： POST

接口描述：

删除动态：会删除相关联的评论点赞和图片数据
后端代码：https://github.com/Chef5/PopRun-b/commit/4c26bf0f3e195d0c9f5cde77d14b72970fbbf7bd

遗留问题：因为技术原因，暂时没有做删除图片文件处理，仅做了删除图片数据

请求示例：

{
  "rid": 27,
  "moid": 4
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": null
}

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	null	非必须

发布动态

基本信息

Path： /api/moments/doMoment

Method： POST

接口描述：

以rid识别用户，发布动态文字和图片至少需要一个

后端代码：https://github.com/Chef5/PopRun-b/commit/7fb55407626b6a9e198f14fcf31466771508d6e2

请求示例：

{
    "rid":27,
    "text":"这里是文字\n部分这里是文字部分这里\n是文部分这里是文字部分这里是文字部分这里是文字部分这里是文字部分这里\n是文字部分",
    "imgs":[
        {
            "name":"微信图片_20190507214403.jpg",
            "store":"5e332173136b3",
            "extension":"jpg",
            "mimetype":"image/jpeg",
            "size":149155,
            "width":1080,
            "height":1920,
            "mwidth":200,
            "mheight":356,
            "original":"http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
            "thumbnail":"http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
            "error":0
        },
        {
            "name":"h1-classfon31-mgb15-h1-tapchihoaky-com-thumb.jpg",
            "store":"5e33d15d2896e",
            "extension":"jpg",
            "mimetype":"image/jpeg",
            "size":202219,
            "width":1200,
            "height":800,
            "mwidth":200,
            "mheight":133,
            "original":"http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
            "thumbnail":"http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
            "error":0
        }
    ]
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": 27,
    "text": "这里是文字\n部分这里是文字部分这里\n是文部分这里是文字部分这里是文字部分这里是文字部分这里是文字部分这里\n是文字部分",
    "updated_at": "2020-02-03 14:40:08",
    "created_at": "2020-02-03 14:40:08",
    "moid": 22,
    "imgs": {
      "original": [
        {
          "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
          "width": 1080,
          "height": 1920
        },
        {
          "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
          "width": 1200,
          "height": 800
        }
      ],
      "thumbnail": [
        {
          "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
          "width": 200,
          "height": 356
        },
        {
          "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
          "width": 200,
          "height": 133
        }
      ]
    }
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
rid	number	必须	发布人
text	string	非必须	动态文字内容
imgs	object []	非必须	动态图片内容	item 类型: object
├─ name	string	非必须
├─ store	string	非必须
├─ extension	string	非必须
├─ mimetype	string	非必须
├─ size	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ mwidth	number	非必须
├─ mheight	number	非必须
├─ original	string	非必须
├─ thumbnail	string	非必须
├─ error	number	非必须
location	string	非必须	位置：可选
latitude	number	非必须	位置维度
longitude	number	非必须	位置经度

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须	用户id
├─ text	string	非必须	动态内容
├─ updated_at	string	非必须
├─ created_at	string	非必须
├─ moid	number	非必须	动态唯一id
├─ imgs	object	非必须	动态包含的图片
├─ original	object []	非必须	原图	item 类型: object
├─ url	string	必须
├─ width	number	必须
├─ height	number	必须
├─ thumbnail	object []	非必须	缩略图	item 类型: object
├─ url	string	必须
├─ width	number	必须
├─ height	number	必须

发表评论

基本信息

Path： /api/moments/doComment

Method： POST

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/6015c2a9662f0fdd836b18fcade63f2a15938f35

请求示例：

{
  "rid":18,
  "moid":1,
  "comment":"跑得不错，厉害了"
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": 18,
    "moid": 22,
    "comment": "跑得不错，厉害了",
    "updated_at": "2020-02-03 14:43:23",
    "created_at": "2020-02-03 14:43:23",
    "coid": 6
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
rid	number	必须	评论者
moid	number	必须	评论动态
comment	string	必须	评论内容

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ moid	number	非必须
├─ comment	string	非必须
├─ updated_at	string	非必须
├─ created_at	string	非必须
├─ coid	number	非必须

取消点赞

基本信息

Path： /api/moments/doDislike

Method： POST

接口描述：

点赞后取消点赞主要在前端处理，不用通过判断返回值判断是否成功
后端代码：https://github.com/Chef5/PopRun-b/commit/d67fb229dd9f1a1afa224697e7515ebd4815ce80

请求示例：

{
  "rid": 27,
  "moid": 11
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": null
}

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	null	非必须

删除评论

基本信息

Path： /api/moments/delComment

Method： GET

接口描述：

只能删除自己的发表的评论
后端代码：

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": null
}

请求参数

Query

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

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	null	非必须

获取个人动态

基本信息

Path： /api/moments/getMine

Method： POST

接口描述：

动态列表数量较多，采取分页处理，首次获取时可以不传分页数据，后端会返回默认首次分页（pageindex=1，pagesize=10），之后加载更多时，需要传递（第一页为1）
首次可以自定义pageindex, pagesize
后端代码：
    https://github.com/Chef5/PopRun-b/commit/a6fba18d30c712af2016482bbffc5025cf331069
    https://github.com/Chef5/PopRun-b/commit/b8180673569c758f021162824ce8aa3dac17fe46 纠正
  https://github.com/Chef5/PopRun-b/commit/01639597a50b1bc5b84e7b25ddb36f0c2c46a7d5 添加用户头像返回
  https://github.com/Chef5/PopRun-b/commit/55c9063c6d9e734668874d2f5f4e6a141a4b7b82   添加用户头像返回

请求示例：

{
  "rid": 27,
  "pageindex": 0, //首次可不传，也可以传当前页码为0
  "pagesize": 2
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": 27,
    "pageindex": 1,
    "pagesize": 2,
    "pageall": 4,
    "moments": [
      {
        "moid": 5,
        "rid": 27,
        "text": "这里是文字\n部分这里是文字部分这里\n是文部分这里是文字部分这里是文字部分这里是文字部分这里是文字部分这里\n是文字部分",
        "created_at": "2020-02-01 15:37:19",
        "updated_at": "2020-02-01 15:37:19",
        "comments": [
          {
            "coid": 4,
            "rid": 16,
            "moid": 5,
            "comment": "Duis minim dolore officia 123123",
            "created_at": "2020-02-02 00:42:40",
            "updated_at": "2020-02-02 00:42:40",
            "nickname": null
          },
          {
            "coid": 5,
            "rid": 17,
            "moid": 5,
            "comment": "Duis minim asdasd",
            "created_at": "2020-02-02 00:42:49",
            "updated_at": "2020-02-02 00:42:49",
            "nickname": null
          }
        ],
        "likes": [
          {
            "moid": 5,
            "rid": 17,
            "created_at": "2020-02-02 00:54:00",
            "updated_at": "2020-02-02 00:54:00",
            "img": null
          }
        ],
        "imgs": {
          "original": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
              "width": 1080,
              "height": 1920
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
              "width": 1200,
              "height": 800
            }
          ],
          "thumbnail": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
              "width": 200,
              "height": 356
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
              "width": 200,
              "height": 133
            }
          ]
        }
      },
      {
        "moid": 6,
        "rid": 27,
        "text": "这里是文字\n部分这里是文字部分这里\n是文部分这里是文字部分这里是文字部分这里是文字部分这里是文字部分这里\n是文字部分",
        "created_at": "2020-02-01 15:37:27",
        "updated_at": "2020-02-01 15:37:27",
        "comments": [],
        "likes": [],
        "imgs": {
          "original": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
              "width": 1080,
              "height": 1920
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
              "width": 1200,
              "height": 800
            }
          ],
          "thumbnail": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
              "width": 200,
              "height": 356
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
              "width": 200,
              "height": 133
            }
          ]
        }
      }
    ]
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
rid	number	必须		用户id	最大值: 10000 最小值: 0 mock: @integer
pageindex	number	非必须	0	当前页，首次可不传，之后返回数据有	mock: @integer
pagesize	number	非必须	10	每页动态数，首次不传默认10，之后有返回	mock: @integer
pageall	number	非必须		总页数，首次不传后端会计算

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须	用户id
├─ pageindex	number	非必须	当前页
├─ pagesize	number	非必须	每页大小
├─ pageall	number	非必须	总页数
├─ moments	object []	非必须	具体动态列表	item 类型: object
├─ moid	number	非必须	动态id
├─ rid	number	非必须
├─ text	string	非必须	动态文本内容
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ comments	object []	非必须	评论列表	item 类型: object
├─ coid	number	非必须	评论id
├─ rid	number	非必须	评论人id
├─ moid	number	非必须
├─ comment	string	非必须	评论内容
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ nickname	null	非必须	评论人昵称
├─ likes	object []	非必须	点赞列表	item 类型: object
├─ moid	number	非必须
├─ rid	number	非必须	点赞人id
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ img	null	非必须	点赞人头像url
├─ imgs	object	非必须	动态图片列表
├─ original	object []	非必须	原图	item 类型: object
├─ url	string	非必须	原图url
├─ width	number	非必须
├─ height	number	非必须
├─ thumbnail	object []	非必须	缩略图	item 类型: object
├─ url	string	非必须	缩略图url
├─ width	number	非必须
├─ height	number	非必须

获取动态

基本信息

Path： /api/moments/getMoments

Method： POST

接口描述：

获取大家的动态，顺序为按发布时间逆序（即最新发布的排前面）
分页数据首次可以不传，后端默认（pageindex=0 , pagesize=10）
后端代码：https://github.com/Chef5/PopRun-b/commit/6657f847a431a8d03d0eda9f3bcb921c5c5ece98

请求示例：

{
   "pageindex": 0,
   "pagesize": 3
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "pageindex": 1,
    "pagesize": 3,
    "moments": [
      {
        "moid": 21,
        "rid": 19,
        "type": 0,
        "text": "这里是19哈哈哈少时诵诗书所哈",
        "created_at": "2020-02-02 19:33:55",
        "updated_at": "2020-02-02 19:33:55",
        "nickname": null,
        "img": null,
        "comments": [],
        "likes": [],
        "imgs": {
          "original": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
              "width": 1080,
              "height": 1920
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
              "width": 1200,
              "height": 800
            }
          ],
          "thumbnail": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
              "width": 200,
              "height": 356
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
              "width": 200,
              "height": 133
            }
          ]
        }
      },
      {
        "moid": 20,
        "rid": 19,
        "text": "这里是19哈哈哈少时诵诗书所哈",
        "created_at": "2020-02-02 19:33:54",
        "updated_at": "2020-02-02 19:33:54",
        "nickname": null,
        "img": null,
        "comments": [],
        "likes": [],
        "imgs": {
          "original": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
              "width": 1080,
              "height": 1920
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
              "width": 1200,
              "height": 800
            }
          ],
          "thumbnail": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
              "width": 200,
              "height": 356
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
              "width": 200,
              "height": 133
            }
          ]
        }
      },
      {
        "moid": 19,
        "rid": 19,
        "text": "这里是19哈哈哈少时诵诗书所哈",
        "created_at": "2020-02-02 19:33:53",
        "updated_at": "2020-02-02 19:33:53",
        "nickname": null,
        "img": null,
        "comments": [],
        "likes": [],
        "imgs": {
          "original": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
              "width": 1080,
              "height": 1920
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
              "width": 1200,
              "height": 800
            }
          ],
          "thumbnail": [
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
              "width": 200,
              "height": 356
            },
            {
              "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
              "width": 200,
              "height": 133
            }
          ]
        }
      }
    ]
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
pageindex	number	必须	0	首次可不传	mock: 1-10
pagesize	number	必须	10	首次可不传	mock: 3

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须		mock: @boolean
msg	string	非必须		mock: @string
data	object	非必须
├─ pageindex	number	非必须	当前页	mock: @integer
├─ pagesize	number	非必须	每页大小	mock: @integer
├─ moments	object []	非必须	动态列表	item 类型: object
├─ moid	number	非必须	动态id	mock: 1-100
├─ rid	number	非必须	用户id	mock: 1-100
├─ nickname	string	非必须	用户昵称
├─ img	string	非必须	用户头像	mock: @url
├─ text	string	非必须	动态内容
├─ type	number	非必须	0一般动态，1打卡分享
├─ created_at	string	非必须	发布时间
├─ updated_at	string	非必须
├─ comments	object []	非必须	评论	item 类型: object
├─ coid	number	非必须
├─ rid	number	非必须	评论人
├─ moid	number	非必须
├─ comment	string	非必须	评论内容
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ nickname	null	非必须	评论人昵称
├─ likes	object []	非必须	点赞	item 类型: object
├─ moid	number	非必须
├─ rid	number	非必须	点赞人
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ img	null	非必须	点赞人头像
├─ imgs	object	非必须	动态图片
├─ original	object []	非必须	原图	item 类型: object
├─ url	string	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ thumbnail	object []	非必须	缩略图	item 类型: object
├─ url	string	非必须
├─ width	number	非必须
├─ height	number	非必须

获取广告（暂不实现）

基本信息

Path： /api/moments/getAd

Method： GET

接口描述：

请求参数

获取推荐

基本信息

Path： /api/moments/getHot

Method： GET

接口描述：

获取最近七天内点赞最多的动态，用于前端热门展示

请求参数

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ moid	number	非必须	动态id
├─ rid	number	非必须	用户id
├─ text	null	非必须	动态内容
├─ location	null	非必须	动态位置
├─ latitude	null	非必须	位置经度
├─ longitude	null	非必须	位置纬度
├─ type	number	非必须	动态类型
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ nickname	string	非必须	用户昵称
├─ img	string	非必须	用户头像
├─ comments	object []	非必须	动态内容	item 类型: object
├─ coid	number	必须
├─ rid	number	必须
├─ moid	number	必须
├─ comment	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ nickname	string	必须
├─ likes	object []	非必须	获取点赞	item 类型: object
├─ moid	number	非必须
├─ rid	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ img	string	非必须
├─ imgs	object	非必须	动态图片
├─ original	object []	非必须		item 类型: object
├─ url	string	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ thumbnail	object []	非必须		item 类型: object
├─ url	string	非必须
├─ width	number	非必须
├─ height	number	非必须

获取某条动态

基本信息

Path： /api/moments/getMomentById

Method： GET

接口描述：

后端代码：
  https://github.com/Chef5/PopRun-b/commit/323f77259c7668cf06784d6c70658da668c1e302
  https://github.com/Chef5/PopRun-b/commit/01639597a50b1bc5b84e7b25ddb36f0c2c46a7d5 添加用户头像返回
  https://github.com/Chef5/PopRun-b/commit/55c9063c6d9e734668874d2f5f4e6a141a4b7b82   添加用户头像返回

请求示例：

http://127.0.0.1:8000/api/moments/getMomentById?moid=22

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "moid": 22,
    "rid": 27,
    "text": "这里是文字\n部分这里是文字部分这里\n是文部分这里是文字部分这里是文字部分这里是文字部分这里是文字部分这里\n是文字部分",
    "created_at": "2020-02-03 14:40:08",
    "updated_at": "2020-02-03 14:40:08",
    "comments": [
      {
        "coid": 6,
        "rid": 18,
        "moid": 22,
        "comment": "跑得不错，厉害了",
        "created_at": "2020-02-03 14:43:23",
        "updated_at": "2020-02-03 14:43:23",
        "nickname": null
      }
    ],
    "likes": [
      {
        "moid": 22,
        "rid": 27,
        "created_at": "2020-02-03 14:44:09",
        "updated_at": "2020-02-03 14:44:09",
        "img": null
      }
    ],
    "imgs": {
      "original": [
        {
          "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
          "width": 1080,
          "height": 1920
        },
        {
          "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
          "width": 1200,
          "height": 800
        }
      ],
      "thumbnail": [
        {
          "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
          "width": 200,
          "height": 356
        },
        {
          "url": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
          "width": 200,
          "height": 133
        }
      ]
    }
  }
}

请求参数

Query

参数名称	是否必须	示例	备注
moid	是	3	动态id

Body

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

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ moid	number	非必须
├─ rid	number	非必须
├─ text	string	非必须
├─ type	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ nickname	null	非必须	用户昵称
├─ img	null	非必须	用户头像
├─ comments	object []	非必须		item 类型: object
├─ coid	number	非必须
├─ rid	number	非必须
├─ moid	number	非必须
├─ comment	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ nickname	string	非必须
├─ likes	object []	非必须		item 类型: object
├─ moid	number	必须
├─ rid	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ img	null	必须
├─ imgs	object	非必须
├─ original	string []	非必须		item 类型: string
├─		非必须
├─ thumbnail	string []	非必须		item 类型: string
├─		非必须

跑步相关 api/run/

获取排行榜【月榜周榜合并】

基本信息

Path： /api/run/getRanking

Method： GET

接口描述：

type后端只检测了是否为0（周榜），其他参数和值均表示月榜。
后端代码：https://github.com/Chef5/PopRun-b/commit/5b985e0bfd5ff6063b1ba55a3e7834c45124abde

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "rid": 5,
      "nickname": "Chef5",
      "img": null,
      "team": "成都理工大学",
      "sumD": "286.40",
      "sumT": "1333332",
      "avgS": "12355.00"
    },
    {
      "rid": 2,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "259.14",
      "sumT": "1999998",
      "avgS": "12355.00"
    },
    {
      "rid": 6,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "10.00",
      "sumT": "666666",
      "avgS": "12355.00"
    },
    {
      "rid": 7,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "1.00",
      "sumT": "666666",
      "avgS": "12355.00"
    }
  ]
}

请求参数

Query

参数名称	是否必须	示例	备注
team	是	成都理工大学
type	否	1	0 周榜，不传或者传其他任何值月榜（默认）

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须		item 类型: object
├─ rid	number	必须
├─ nickname	string,null	必须
├─ img	null	必须
├─ team	string	必须
├─ sumD	string	必须	总里程
├─ sumT	string	必须	总运动时间
├─ avgS	string	必须	平均速度

分享到动态圈子

基本信息

Path： /api/run/doShare

Method： POST

接口描述：

运动只能分享一次，已分享过的无法再分享
调用该接口前，先将分享图片上传

后端代码：https://github.com/Chef5/PopRun-b/commit/ee521b3d6e3cbf0f1789e81100ca7af5dd22b7ed

请求示例：

{
  "ruid": 1,
  "rid": 22,
  "text": "艰难的一天",
  "img": {
}

}

返回示例：

{
    "isSuccess": true,
    "msg": "操作成功",
    "data": "操作成功"
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
ruid	string	必须	运动ruid
rid	string	必须	用户rid
text	string	非必须	分享文字
img	object	必须

返回数据

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

获取个人排行榜信息【月榜周榜合并】

基本信息

Path： /api/run/getMyRanking

Method： GET

接口描述：

当本周或者本月没有运动数据时，data返回为 null
后端代码：https://github.com/Chef5/PopRun-b/commit/66439032a3a132bb0ee237e395545b15b764da3e

返回示例：

{ "isSuccess": true, "msg": "操作成功", "data": { "rid": 2, "nickname": null, "img": null, "team": "成都理工大学", "sumD": "259.14", "sumT": "1999998", "avgS": "12355.00", "rank": 2 } }

{ "isSuccess": true, "msg": "操作成功", "data": null }

请求参数

Query

参数名称	是否必须	示例	备注
rid	是	9	用户id
type	否	0	周榜0，月榜1（默认）

返回数据

名称	类型	是否必须	备注
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ nickname	null	非必须
├─ img	null	非必须
├─ team	string	非必须
├─ sumD	string	非必须
├─ sumT	string	非必须
├─ avgS	string	非必须
├─ rank	number	非必须	个人排名

获取个人运动列表

基本信息

Path： /api/run/getMyRuns

Method： GET

接口描述：

获取某个人的所有运动列表，采用分页。pageindex，pagesize（默认10）
后端代码：https://github.com/Chef5/PopRun-b/commit/ae6d85eea84d4ec3d6bc58de8502770ab5fa06b4

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": "6",
    "pageindex": 1,
    "pagesize": 10,
    "runs": [
      {
        "ruid": 8,
        "rid": 6,
        "distance": null,
        "calorie": null,
        "speed_top": null,
        "speed_low": null,
        "speed": null,
        "time_start": "2020-04-01 15:40:20",
        "time_end": null,
        "time_run": null,
        "latitude_start": "12.1231235123",
        "longitude_start": "34.342343434",
        "latitude_end": null,
        "longitude_end": null,
        "isshared": 0,
        "created_at": "2020-04-16 08:47:25",
        "updated_at": "2020-04-16 08:47:25",
        "imgs": null
      },
      {
        "ruid": 6,
        "rid": 6,
        "distance": "10",
        "calorie": "66",
        "speed_top": "12",
        "speed_low": "1",
        "speed": "12355",
        "time_start": "2020-04-01 12:30:00",
        "time_end": "2020-04-01 12:30:00",
        "time_run": 666666,
        "latitude_start": "wwww",
        "longitude_start": "aaa",
        "latitude_end": "234 dolore",
        "longitude_end": "ad",
        "isshared": 0,
        "created_at": "2020-04-15 19:28:56",
        "updated_at": "2020-04-15 19:28:56",
        "imgs": {
          "original": "http://dev.run.nunet.cn/resources/images/2020-02-04/5e3858831fa42-1080x1920.jpg",
          "thumbnail": "http://dev.run.nunet.cn/resources/images/2020-02-04/5e3858831fa42-min-200x356.jpg"
        }
      }
    ]
  }
}

请求参数

Query

参数名称	是否必须	示例	备注
rid	是	1	用户id
pageindex	否
pagesize	否		默认10

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	string	非必须
├─ pageindex	number	非必须
├─ pagesize	number	非必须
├─ runs	object []	非必须	item 类型: object
├─ ruid	number	必须
├─ rid	number	必须
├─ distance	null,string	必须
├─ calorie	null,string	必须
├─ speed_top	null,string	必须
├─ speed_low	null,string	必须
├─ speed	null,string	必须
├─ time_start	string	必须
├─ time_end	null,string	必须
├─ time_run	null,number	必须
├─ latitude_start	string	必须
├─ longitude_start	string	必须
├─ latitude_end	null,string	必须
├─ longitude_end	null,string	必须
├─ isshared	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ imgs	object	必须
├─ original	string	非必须
├─ thumbnail	string	非必须

获取个人运动数据统计

基本信息

Path： /api/run/getMyRunsData

Method： GET

接口描述：

数据统计按照已完成运动进行统计的：
其中平均速度是将每次运动的平均速度用来计算的
后端代码：https://github.com/Chef5/PopRun-b/commit/01bd59e57418f9319042d39f2621fad2276cc46f

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "times": 3,
      "sumD": "259.14",
      "maxD": "13.00",
      "sumT": "1999998",
      "maxT": 666666,
      "avgS": "12355.00",
      "maxS": "12355",
      "minS": "12355"
    }
  ]
}

请求参数

Query

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

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须		item 类型: object
├─ times	number	非必须	运动次数
├─ sumD	string	非必须	总里程
├─ maxD	string	非必须	单次最大里程
├─ sumT	string	非必须	运动总时长
├─ maxT	number	非必须	单次最大运动时长
├─ avgS	string	非必须	总平均速度
├─ maxS	string	非必须	最大平均速度
├─ minS	string	非必须	最小平均速度

获取周榜

基本信息

Path： /api/run/getWeekrank

Method： GET

接口描述：

返回本周前100（按照本周总里程排名）
后端代码：https://github.com/Chef5/PopRun-b/commit/8bb451d21db23c2fbc52eff26ec9558f76a182d1
调整（排除未完成运动记录）：https://github.com/Chef5/PopRun-b/commit/d6c80da52f72dba7359314a1f0068cff71ddc6f2

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "rid": 5,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "286.40",
      "sumT": "1333332",
      "avgS": "12355.00"
    },
    {
      "rid": 2,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "259.14",
      "sumT": "1999998",
      "avgS": "12355.00"
    },
    {
      "rid": 6,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "10.00",
      "sumT": "666666",
      "avgS": "12355.00"
    },
    {
      "rid": 7,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "1.00",
      "sumT": "666666",
      "avgS": "12355.00"
    }
  ]
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
team	是	成都理工大学	校区

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须		item 类型: object
├─ rid	number	必须
├─ nickname	null	必须
├─ img	null	必须
├─ team	string	必须
├─ sumD	number	必须	本周跑步总里程
├─ sumT	string	必须	本周跑步总时长
├─ avgS	number	必须	本周跑步平均速度

删除运动

基本信息

Path： /api/run/delRun

Method： POST

接口描述：

返回示例：

{"isSuccess":true,"msg":"\u64cd\u4f5c\u6210\u529f","data":null}

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	null	非必须

获取月榜

基本信息

Path： /api/run/getMonthrank

Method： GET

接口描述：

获取本月前100（按照总里程排行）
后端代码：https://github.com/Chef5/PopRun-b/commit/0d81b6fc0d66b415e81331e398b5647451252110
调整（排除未完成运动记录）：https://github.com/Chef5/PopRun-b/commit/d6c80da52f72dba7359314a1f0068cff71ddc6f2

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "rid": 5,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "286.40",
      "sumT": "1333332",
      "avgS": "12355.00"
    },
    {
      "rid": 2,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "259.14",
      "sumT": "1999998",
      "avgS": "12355.00"
    },
    {
      "rid": 6,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "10.00",
      "sumT": "666666",
      "avgS": "12355.00"
    },
    {
      "rid": 7,
      "nickname": null,
      "img": null,
      "team": "成都理工大学",
      "sumD": "1.00",
      "sumT": "666666",
      "avgS": "12355.00"
    }
  ]
}

请求参数

Query

参数名称	是否必须	示例	备注
team	是	成都理工大学

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须		item 类型: object
├─ rid	number	必须
├─ nickname	null	必须
├─ img	null	必须
├─ team	string	必须
├─ sumD	string	必须	本月总里程
├─ sumT	string	必须	本月总运动时长
├─ avgS	string	必须	本月平均跑步速度

获取某次运动

基本信息

Path： /api/run/getRunById

Method： GET

接口描述：

用户信息可以由前端上层传入，这里后端就不在查询返回用户数据了，节省内存
后端代码：https://github.com/Chef5/PopRun-b/commit/716616ead2e5904dc07ae95d1fc7cdf3e1dbb2cc

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "ruid": 76,
    "rid": 10,
    "distance": "0.69",
    "calorie": 39,
    "speed_top": "7.83",
    "speed_low": "0.00",
    "speed": "1.02",
    "time_start": "2020-04-25 12:44:07",
    "time_end": "2020-04-22 11:58:59",
    "time_run": 3,
    "latitude_start": "30.583277723500000",
    "longitude_start": "104.061295030300000",
    "latitude_end": "30.585096571100000",
    "longitude_end": "104.062658962600000",
    "isshared": 0,
    "created_at": "2020-04-22 11:56:14",
    "updated_at": "2020-04-22 11:59:04"
  }
}

请求参数

Query

参数名称	是否必须	示例	备注
ruid	是	1	运动id

返回数据

名称	类型	是否必须	备注
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ ruid	number	非必须
├─ rid	number	非必须
├─ distance	string	非必须
├─ calorie	string	非必须
├─ speed_top	string	非必须
├─ speed_low	string	非必须
├─ speed	string	非必须
├─ time_start	string	非必须
├─ time_end	string	非必须
├─ time_run	number	非必须
├─ latitude_start	string	非必须
├─ longitude_start	string	非必须
├─ latitude_end	string	非必须
├─ longitude_end	string	非必须
├─ isshared	number	非必须	0未分享，1已分享
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ img	object	非必须
├─ original	string	非必须
├─ thumbnail	string	非必须

获取随机一言

基本信息

Path： /api/run/getHitokoto

Method： GET

接口描述：

此接口盗用的https://alapi.cn/hitokoto.html，目前暂时每次请求后保存到本数据库，之后便可不再依赖其接口了。
返回5条随机语言。

type（可不传）	说明
a	Anime - 动画
b	Comic – 漫画
c	Game – 游戏
d	Novel – 小说
e	Myself – 原创
f	Internet – 来自网络
g	Other – 其他

后端代码：https://github.com/Chef5/PopRun-b/commit/1c4a3d873d9887b04285ea6b7499836f55b1986d
后端代码-调整为5条：https://github.com/Chef5/PopRun-b/commit/d23846a1674d1e8330920ba9b3804a2232b2aad1

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "id": 1,
      "hitokoto": "那年的春天，那年的三月。你给我一个承诺，我就哭了。你给我一段爱情，我就真的站在这里舍不得走了。",
      "type": "d",
      "from": "深海里的星星",
      "creator": "zhouzz"
    },
    {
      "id": 2,
      "hitokoto": "你永远是我唯爱旅行中名为秘密的起点站。",
      "type": "d",
      "from": "绘心",
      "creator": "Samurai"
    },
    {
      "id": 3,
      "hitokoto": "死亡是唯一一座永远亮着的灯塔，不管你向哪里航行，最终都得转向它指引的方向。一切终会逝去，只有死神永生。",
      "type": "d",
      "from": "三体：死神永生",
      "creator": "悠远的苍穹"
    },
    {
      "id": 4,
      "hitokoto": "不需要逃避，也不必看轻自己，接受自己的不完美，更加努力，凡是打不倒你的都会让你变得更加坚强。",
      "type": "e",
      "from": "Bruce Jc",
      "creator": "Bruce jcworm"
    },
    {
      "id": 5,
      "hitokoto": "爱是等待，是细水长流。",
      "type": "e",
      "from": "临沂冈田武",
      "creator": "临沂彭于晏"
    }
  ]
}

请求参数

Query

参数名称	是否必须	示例	备注
type	否	a	a,b,c,d,e,f,g

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须	item 类型: object
├─ id	number	必须
├─ hitokoto	string	必须
├─ type	string	必须
├─ from	string	必须
├─ creator	string	必须

跑步开始

基本信息

Path： /api/run/doStart

Method： POST

接口描述：

跑步数据初始化：作用是，当用户跑步结束后，保存失败或者直接退出程序也同样有记录。这类记录到时候在个人运动中统计为未完成运动状态。
这里主要是拿到ruid，提供给跑步结束doEnd使用
后端代码：https://github.com/Chef5/PopRun-b/commit/f4994330cb0b56c88d2bbeb215628d3d6757008e

请求示例：

{
  "rid": 22,
  "time_start": "2020-04-01 15:40:20",
  "latitude_start": "12.1231235123",
  "longitude_start": "34.342343434"
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "ruid": 2,
    "rid": 22,
    "distance": null,
    "calorie": null,
    "speed_top": null,
    "speed_low": null,
    "speed": null,
    "time_start": "2020-04-01 15:40:20",
    "time_end": null,
    "time_run": null,
    "latitude_start": "12.1231235123",
    "longitude_start": "34.342343434",
    "latitude_end": null,
    "longitude_end": null,
    "isshared": "0",
    "created_at": "2020-04-01 15:44:10",
    "updated_at": "2020-04-01 15:44:10"
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
rid	integer	必须	用户id
time_start	string	必须	开始时间，格式："2020-04-02 08:30:00"
latitude_start	string	必须	起点维度
longitude_start	string	必须	起点经度

返回数据

名称	类型	是否必须	备注
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ ruid	number	非必须
├─ rid	number	非必须
├─ distance	null	非必须
├─ calorie	null	非必须
├─ speed_top	null	非必须
├─ speed_low	null	非必须
├─ speed	null	非必须
├─ time_start	string	非必须	格式："2020-04-02 08:30:00"
├─ time_end	null	非必须
├─ time_run	null	非必须
├─ latitude_start	string	非必须
├─ longitude_start	string	非必须
├─ latitude_end	null	非必须
├─ longitude_end	null	非必须
├─ isshared	string	非必须	默认0未分享，1已分享
├─ created_at	string	非必须
├─ updated_at	string	非必须

跑步结束

基本信息

Path： /api/run/doEnd

Method： POST

接口描述：

（如果没有使用跑步开始接口doStart，就没有ruid，那么这里ruid可以换成用户rid，然后参数全部必须传）
运动时长：传分钟数

后端代码：https://github.com/Chef5/PopRun-b/commit/27251de4c69062a522d50ae2efa71d7cde463f51

请求示例：

{
    "ruid": 1,
    "distance": "123",
    "calorie": "66",
    "speed_top": "12",
    "speed_low": "1",
    "time_run": "666666",
    "speed": "12355",
    "latitude_end": "234 dolore",
    "longitude_end": "ad",
    "time_end": "2020-04-01 12:30:00"
 }

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "ruid": 1,
    "rid": 22,
    "distance": "123",
    "calorie": "66",
    "speed_top": "12",
    "speed_low": "1",
    "speed": "12355",
    "time_start": "2020-04-01 12:00:00",
    "time_end": "2020-04-01 12:30:00",
    "time_run": 666666,
    "latitude_start": "12123123123",
    "longitude_start": "enim labore",
    "latitude_end": "234 dolore",
    "longitude_end": "ad",
    "isshared": "0",
    "created_at": "2020-04-01 16:24:49",
    "updated_at": "2020-04-01 16:32:00"
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
ruid	integer	必须	运动id
distance	number	必须	里程
calorie	number	必须	卡路里
speed_top	number	必须	最高配速
speed_low	number	必须	最低配速
speed	number	必须	平均配速
time_start	string	非必须	开始时间
time_end	string	必须	结束时间
time_run	number	必须	运动时长（分钟）
latitude_start	number	非必须	起点维度
longitude_start	number	非必须	起点经度
latitude_end	number	必须	终点维度
longitude_end	number	必须	终点经度

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ ruid	number	非必须
├─ rid	number	非必须
├─ distance	string	非必须
├─ calorie	string	非必须
├─ speed_top	string	非必须
├─ speed_low	string	非必须
├─ speed	string	非必须
├─ time_start	string	非必须
├─ time_end	string	非必须
├─ time_run	number	非必须
├─ latitude_start	string	非必须
├─ longitude_start	string	非必须
├─ latitude_end	string	非必须
├─ longitude_end	string	非必须
├─ isshared	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

活动广场 api/pub/

创建活动【后台管理】

基本信息

Path： /api/pub/doActivity

Method： POST

接口描述：

该接口仅用于管理员创建活动，前端不实现
period表示活动过期时间，不传默认当前时间+30天
后端代码：https://github.com/Chef5/PopRun-b/commit/982511686988c4d477d9394912563477ebaeea5c
后端代码（数据库调整）：https://github.com/Chef5/PopRun-b/commit/e14e035e029326b0542aa9ae7fd924d586bb4aaf
发送示例：

{
    "title": "2020成都马拉松报名",
    "desc": "新的征程，新的赛场，新的不造",
    "meid": 3,
    "content":"这里是详细介绍详细介绍有很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多的文字",
    "cover":
        {
            "name":"h1-classfon31-mgb15-h1-tapchihoaky-com-thumb.jpg",
            "store":"5e33d15d2896e",
            "extension":"jpg",
            "mimetype":"image/jpeg",
            "size":202219,
            "width":1200,
            "height":800,
            "mwidth":200,
            "mheight":133,
            "original":"http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
            "thumbnail":"http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
            "error":0
        },
    "imgs":[
        {
            "name":"微信图片_20190507214403.jpg",
            "store":"5e332173136b3",
            "extension":"jpg",
            "mimetype":"image/jpeg",
            "size":149155,
            "width":1080,
            "height":1920,
            "mwidth":200,
            "mheight":356,
            "original":"http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
            "thumbnail":"http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
            "error":0
        },
        {
            "name":"h1-classfon31-mgb15-h1-tapchihoaky-com-thumb.jpg",
            "store":"5e33d15d2896e",
            "extension":"jpg",
            "mimetype":"image/jpeg",
            "size":202219,
            "width":1200,
            "height":800,
            "mwidth":200,
            "mheight":133,
            "original":"http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
            "thumbnail":"http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg",
            "error":0
        }
    ]
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "title": "2020成都马拉松报名",
    "desc": "新的征程，新的赛场，新的不造",
    "cover": {
      "original": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
      "thumbnail": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg"
    },
    "content": "这里是详细介绍详细介绍有很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多的文字",
    "period": "2020-05-14 09:34:32",
    "updated_at": "2020-04-14 09:34:32",
    "created_at": "2020-04-14 09:34:32",
    "acid": 6,
    "imgs": [
      [
        "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
        "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg"
      ],
      [
        "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
        "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg"
      ]
    ],
    "medal": {
      "meid": 3,
      "mkey": "star_3_act",
      "type": 0,
      "desc": "单次运动里程达15km",
      "name": "3星跑者",
      "img": "http://127.0.0.1:8000/resources/medals/star_3_act.png",
      "created_at": "2020-04-14 09:25:53",
      "updated_at": "2020-04-14 09:25:53"
    }
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
title	string	必须	活动标题
desc	string	必须	活动简要描述
meid	number	必须	活动勋章id
content	string	非必须	活动内容
cover	object	必须	活动封面图
├─ name	string	非必须
├─ store	string	非必须
├─ extension	string	非必须
├─ mimetype	string	非必须
├─ size	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ mwidth	number	非必须
├─ mheight	number	非必须
├─ original	string	非必须
├─ thumbnail	string	非必须
├─ error	number	非必须
imgs	object []	非必须	活动内容图片	item 类型: object
├─ name	string	必须
├─ store	string	必须
├─ extension	string	必须
├─ mimetype	string	必须
├─ size	number	必须
├─ width	number	必须
├─ height	number	必须
├─ mwidth	number	必须
├─ mheight	number	必须
├─ original	string	必须
├─ thumbnail	string	必须
├─ error	number	必须
period	string	非必须	截止时间：2020-04-04 12:00:00

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ title	string	非必须
├─ desc	string	非必须
├─ cover	object	非必须
├─ original	string	非必须
├─ thumbnail	string	非必须
├─ content	string	非必须
├─ period	string	非必须
├─ updated_at	string	非必须
├─ created_at	string	非必须
├─ acid	number	非必须
├─ imgs	array []	非必须	item 类型: array
├─		非必须
├─		非必须
├─ medal	object	非必须
├─ meid	number	非必须
├─ mkey	string	非必须
├─ type	number	非必须
├─ desc	string	非必须
├─ name	string	非必须
├─ img	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

创建课程【后台管理】

基本信息

Path： /api/pub/doCourse

Method： POST

接口描述：

该接口仅仅为管理员创建课程使用，前端不做

在保存课程前需要先上传一张封面图
后端代码：https://github.com/Chef5/PopRun-b/commit/fab2ad8a2620c9cee4b64a985252e24d1905020e

请求示例：

{
    "title": "课程名称",
    "text": "课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容",
    "img":
        {
            "name":"微信图片_20190507214403.jpg",
            "store":"5e332173136b3",
            "extension":"jpg",
            "mimetype":"image/jpeg",
            "size":149155,
            "width":1080,
            "height":1920,
            "mwidth":200,
            "mheight":356,
            "original":"http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
            "thumbnail":"http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
            "error":0
        }
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "title": "课程名称",
    "text": "课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容",
    "updated_at": "2020-04-13 20:15:47",
    "created_at": "2020-04-13 20:15:47",
    "rcid": 3,
    "img": {
      "original": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
      "thumbnail": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg"
    }
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
title	string	必须	课表标题
text	string	必须	课程内容
img	object	必须
├─ name	string	必须
├─ store	string	必须
├─ extension	string	必须
├─ mimetype	string	必须
├─ size	number	必须
├─ width	number	必须
├─ height	number	必须
├─ mwidth	number	必须
├─ mheight	number	必须
├─ original	string	必须
├─ thumbnail	string	必须
├─ error	number	必须

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ title	string	非必须
├─ text	string	非必须
├─ updated_at	string	非必须
├─ created_at	string	非必须
├─ rcid	number	非必须
├─ img	object	非必须
├─ original	string	非必须
├─ thumbnail	string	非必须

报名参加活动

基本信息

Path： /api/pub/signActivity

Method： POST

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/8629a7585a56aeb5de707478b96fea62a149840c

请求示例：

{
  "rid": 2,
  "acid": 5
}

返回示例：

{
  "isSuccess": true,
  "msg": "报名成功",
  "data": {
    "rid": 2,
    "acid": 5,
    "updated_at": "2020-04-14 19:37:52",
    "created_at": "2020-04-14 19:37:52"
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
rid	integer	必须		用户id
acid	integer	必须		活动id

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ acid	number	非必须
├─ updated_at	string	非必须
├─ created_at	string	非必须

查询用户是否已报名

基本信息

Path： /api/pub/signActivityCheck

Method： GET

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/2733565ceb26ba41821112c1ad41a08ee4acb48b

返回示例：

{
  "isSuccess": true,
  "msg": "已报名",
  "data": {
    "rid": 10,
    "acid": 6,
    "isfinished": 1,
    "created_at": "2020-05-31 14:48:31",
    "updated_at": "2020-05-31 15:00:12"
  }
}

请求参数

Query

参数名称	是否必须	示例	备注
rid	是		用户id
acid	是		活动id

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ acid	number	非必须
├─ isfinished	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

获取已报名人数

基本信息

Path： /api/pub/getSignNum

Method： GET

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/36c620f7b3fcf700596a4ba5927ee0c4f95e5cb9

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": 1
}

请求参数

Query

参数名称	是否必须	示例	备注
acid	是		活动id

返回数据

名称	类型	是否必须	备注
isSuccess	boolean	非必须
msg	string	非必须
data	number	非必须	人数

获取活动列表

基本信息

Path： /api/pub/getList

Method： POST

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/ab76e1fccf57bdc75939ff741fdf81b917ab3655
后端代码（数据库调整）：https://github.com/Chef5/PopRun-b/commit/2f7fb9c1225c10dae782606ef43c5d1c12563ead

请求示例：

{
   "pageindex": 0,
   "pagesize": 10
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "pageindex": 1,
    "pagesize": 10,
    "activitys": [
      {
        "acid": 5,
        "meid": 3,
        "title": "2020成都马拉松报名",
        "cover": {
          "original": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
          "thumbnail": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg"
        },
        "desc": "新的征程，新的赛场，新的不造",
        "content": "这里是详细介绍详细介绍有很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多的文字",
        "period": "2020-05-14 09:33:29",
        "created_at": "2020-04-14 09:33:29",
        "updated_at": "2020-04-14 09:33:29",
        "medal": {
          "meid": 3,
          "mkey": "star_3_act",
          "type": 0,
          "desc": "单次运动里程达15km",
          "name": "3星跑者",
          "img": "http://127.0.0.1:8000/resources/medals/star_3_act.png",
          "created_at": "2020-04-14 09:25:53",
          "updated_at": "2020-04-14 09:25:53"
        }
      },
      {
        "acid": 4,
        "meid": 3,
        "title": "2020成都马拉松报名",
        "cover": {
          "original": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
          "thumbnail": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg"
        },
        "desc": "新的征程，新的赛场，新的不造",
        "content": "这里是详细介绍详细介绍有很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多的文字",
        "period": "2020-05-14 09:32:10",
        "created_at": "2020-04-14 09:32:10",
        "updated_at": "2020-04-14 09:32:10",
        "medal": {
          "meid": 3,
          "mkey": "star_3_act",
          "type": 0,
          "desc": "单次运动里程达15km",
          "name": "3星跑者",
          "img": "http://127.0.0.1:8000/resources/medals/star_3_act.png",
          "created_at": "2020-04-14 09:25:53",
          "updated_at": "2020-04-14 09:25:53"
        }
      }
    ]
  }
}

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ pageindex	number	非必须
├─ pagesize	number	非必须
├─ activitys	object []	非必须		item 类型: object
├─ acid	number	必须
├─ meid	number	必须	勋章id
├─ title	string	必须
├─ cover	object	必须	封面图
├─ original	string	非必须
├─ thumbnail	string	非必须
├─ desc	string	必须
├─ content	string	必须
├─ period	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ medal	object	必须	勋章详细
├─ meid	number	非必须
├─ mkey	string	非必须
├─ type	number	非必须
├─ desc	string	非必须
├─ name	string	非必须
├─ img	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

获取活动详细

基本信息

Path： /api/pub/getDetail

Method： GET

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/5a75b61d6c7de3ec2b7596ad7485a34974213841
后端代码（数据库调整）：https://github.com/Chef5/PopRun-b/commit/4238fba9b81c69f1869c9c1c8536268025487bad

请求示例：http://dev.run.nunet.cn/api/pub/getSwipperDetail?acid=4
返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "acid": 4,
    "meid": 3,
    "title": "2020成都马拉松报名",
    "cover": {
      "original": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
      "thumbnail": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg"
    },
    "desc": "新的征程，新的赛场，新的不造",
    "content": "这里是详细介绍详细介绍有很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多很多的文字",
    "period": "2020-05-14 09:32:10",
    "created_at": "2020-04-14 09:32:10",
    "updated_at": "2020-04-14 09:32:10",
    "imgs": {
      "original": [
        "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
        "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg"
      ],
      "thumbnail": [
        "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg",
        "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg"
      ]
    },
    "medal": {
      "meid": 3,
      "mkey": "star_3_act",
      "type": 0,
      "desc": "单次运动里程达15km",
      "name": "3星跑者",
      "img": "http://127.0.0.1:8000/resources/medals/star_3_act.png",
      "created_at": "2020-04-14 09:25:53",
      "updated_at": "2020-04-14 09:25:53"
    }
  }
}

请求参数

Query

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

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ acid	number	非必须	活动id
├─ meid	number	非必须	勋章id
├─ title	string	非必须
├─ cover	object	非必须	封面图
├─ original	string	非必须
├─ thumbnail	string	非必须
├─ desc	string	非必须
├─ content	string	非必须
├─ period	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ imgs	object	非必须	活动图片
├─ original	string []	非必须		item 类型: string
├─		非必须
├─ thumbnail	string []	非必须		item 类型: string
├─		非必须
├─ medal	object	非必须	勋章详细
├─ meid	number	非必须
├─ mkey	string	非必须
├─ type	number	非必须
├─ desc	string	非必须
├─ name	string	非必须
├─ img	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

获取课程列表

基本信息

Path： /api/pub/getCourses

Method： GET

接口描述：

获取课程列表
后端代码：https://github.com/Chef5/PopRun-b/commit/fab2ad8a2620c9cee4b64a985252e24d1905020e

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "rcid": 6,
      "title": "课程名称6",
      "img": {
        "original": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
        "thumbnail": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg"
      }
    },
    {
      "rcid": 5,
      "title": "课程名称5",
      "img": {
        "original": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
        "thumbnail": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg"
      }
    }
  ]
}

请求参数

Query

参数名称	是否必须	示例	备注
num	否	2	获取课程数量，默认2

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须	item 类型: object
├─ rcid	number	必须
├─ title	string	必须
├─ img	object	必须
├─ original	string	非必须
├─ thumbnail	string	非必须

获取课程详细

基本信息

Path： /api/pub/getCourseDetail

Method： GET

接口描述：

点击首页课程，查看课程详细：通过课程rcid获取课程详细
后端代码：https://github.com/Chef5/PopRun-b/commit/f53b6c8af42188c384225cf5ee336fbb3b761460

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rcid": 5,
    "title": "课程名称5",
    "text": "课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容课程内容",
    "created_at": "2020-04-13 20:35:23",
    "updated_at": "2020-04-13 20:35:23",
    "img": {
      "original": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-1080x1920.jpg",
      "thumbnail": "http://127.0.0.1:8000/resources/images/2020-01-31/5e331bb3986ad-min-200x356.jpg"
    }
  }
}

请求参数

Query

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

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rcid	number	非必须
├─ title	string	非必须
├─ text	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ img	object	非必须
├─ original	string	非必须
├─ thumbnail	string	非必须

获取轮播活动

基本信息

Path： /api/pub/getSwipper

Method： GET

接口描述：

获取顶部轮播活动，用于轮播展示，点击后，需调用另外一个接口获取活动详细
后端代码：https://github.com/Chef5/PopRun-b/commit/dd70b413036c74330793b51f5d39bada8b5b15a1
后端代码（数据库调整）：https://github.com/Chef5/PopRun-b/commit/b147964fb886d9509ddfe1e80e099a0698dde869
返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "acid": 5,
      "title": "2020成都马拉松报名",
      "desc": "新的征程，新的赛场，新的不造",
      "cover": {
        "original": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-1200x800.jpg",
        "thumbnail": "http://127.0.0.1:8000/resources/images/2020-01-31/5e33d15d2896e-min-200x133.jpg"
      }
    }
  ]
}

请求参数

Query

参数名称	是否必须	示例	备注
num	否	3	获取数量，默认3个

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须	item 类型: object
├─ acid	number	非必须
├─ title	string	非必须
├─ desc	string	非必须
├─ cover	object	非必须
├─ original	string	非必须
├─ thumbnail	string	非必须

个人中心 api/user/

获取个人运动列表

基本信息

Path： /api/user/getMyRuns

Method： GET

接口描述：

获取某个人的所有运动列表，采用分页。pageindex，pagesize（默认10）
后端代码：https://github.com/Chef5/PopRun-b/commit/ae6d85eea84d4ec3d6bc58de8502770ab5fa06b4

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": "6",
    "pageindex": 1,
    "pagesize": 10,
    "runs": [
      {
        "ruid": 8,
        "rid": 6,
        "distance": null,
        "calorie": null,
        "speed_top": null,
        "speed_low": null,
        "speed": null,
        "time_start": "2020-04-01 15:40:20",
        "time_end": null,
        "time_run": null,
        "latitude_start": "12.1231235123",
        "longitude_start": "34.342343434",
        "latitude_end": null,
        "longitude_end": null,
        "isshared": 0,
        "created_at": "2020-04-16 08:47:25",
        "updated_at": "2020-04-16 08:47:25",
        "imgs": null
      },
      {
        "ruid": 6,
        "rid": 6,
        "distance": "10",
        "calorie": "66",
        "speed_top": "12",
        "speed_low": "1",
        "speed": "12355",
        "time_start": "2020-04-01 12:30:00",
        "time_end": "2020-04-01 12:30:00",
        "time_run": 666666,
        "latitude_start": "wwww",
        "longitude_start": "aaa",
        "latitude_end": "234 dolore",
        "longitude_end": "ad",
        "isshared": 0,
        "created_at": "2020-04-15 19:28:56",
        "updated_at": "2020-04-15 19:28:56",
        "imgs": {
          "original": "http://dev.run.nunet.cn/resources/images/2020-02-04/5e3858831fa42-1080x1920.jpg",
          "thumbnail": "http://dev.run.nunet.cn/resources/images/2020-02-04/5e3858831fa42-min-200x356.jpg"
        }
      }
    ]
  }
}

请求参数

Query

参数名称	是否必须	示例	备注
rid	是	1	用户id
pageindex	否
pagesize	否		默认10

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	string	非必须
├─ pageindex	number	非必须
├─ pagesize	number	非必须
├─ runs	object []	非必须	item 类型: object
├─ ruid	number	必须
├─ rid	number	必须
├─ distance	null,string	必须
├─ calorie	null,string	必须
├─ speed_top	null,string	必须
├─ speed_low	null,string	必须
├─ speed	null,string	必须
├─ time_start	string	必须
├─ time_end	null,string	必须
├─ time_run	null,number	必须
├─ latitude_start	string	必须
├─ longitude_start	string	必须
├─ latitude_end	null,string	必须
├─ longitude_end	null,string	必须
├─ isshared	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ imgs	object	必须
├─ original	string	非必须
├─ thumbnail	string	非必须

上传头像

基本信息

Path： /api/user/uploadImg

Method： POST

接口描述：

修改头像时调用，返回头像地址

后端代码：https://github.com/Chef5/PopRun-b/commit/90142d681840439ec8af34993d1ade70b889f4eb

返回示例：

{
    "isSuccess": true,
    "msg": "上传成功",
    "data": {
        "url": "http://127.0.0.1:8000/resources/userImgs/5e886852bafa9.jpg"
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
img	file	是

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ url	string	非必须

查询所有校区

基本信息

Path： /api/user/getSchools

Method： GET

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/2980ee271ffb4123cc869cbd43f7190d8d6e7b1e
返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "team": "成都理工大学"
    }
  ]
}

请求参数

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须	item 类型: object
├─ team	string	非必须

注销账号（删除所有数据）

基本信息

Path： /api/user/doUnset

Method： POST

接口描述：

只需要传rid或者openid即可

删除r_users: https://github.com/Chef5/PopRun-b/commit/6020cde1c2c9cc1217b864999100d657e898b6ab
其他记录暂时没实现，忘写了

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
rid	number	非必须
openid	string	非必须

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	null	非必须

获取个人信息

基本信息

Path： /api/user/getUser

Method： POST

接口描述：

传参：openid和rid均可证明用户唯一性，传任意一个即可
后端代码：https://github.com/Chef5/PopRun-b/commit/beed0335ec945888454f0ac8bc528af326cf1938
优化记录（增加未注册检测）：https://github.com/Chef5/PopRun/commit/b0cdfd67b862e05bd0690500bcc7b1778e20b0da

请求示例：

{
    "openid": "oZoB85SXO5b4LEtL6SWObUVBuUUs"
}

返回示例：

{ "isSuccess":true, "msg":"操作成功", "data":{ "rid": 9, "openid": "oZoB85ZonTk33GQC4iWxlsbh06UI", "nickname": "しiuyam", "team": null, "sex": "2", "img": "[https://wx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLtLfzx8n8Xaswx5ebF522FgV7VE1FIMXiaPQ5B3WK9oQliabhMWgliaOhuNsXibNSP36uu3AouE91T3g/132](https://wx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLtLfzx8n8Xaswx5ebF522FgV7VE1FIMXiaPQ5B3WK9oQliabhMWgliaOhuNsXibNSP36uu3AouE91T3g/132)", "info": null, "job": null, "created_at": "2020-03-11 19:57:21", "updated_at": "2020-03-11 19:57:21" } }

{ "isSuccess":false, "msg":"未注册", "data":"未注册" }

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
openid	string	非必须		微信openid
rid	number	必须		用户rid

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ openid	string	非必须
├─ nickname	string	非必须
├─ sex	string	非必须
├─ img	string	非必须
├─ team	string	非必须
├─ info	string	非必须
├─ job	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

获取个人信息（含勋章称号）

基本信息

Path： /api/user/getUserAll

Method： POST

接口描述：

获取用户信息，包含所有已获称号（降序：最近获得在前），包含所有已获勋章（升序：先获得在前）
后端代码（完成称号）：https://github.com/Chef5/PopRun-b/commit/0ccf5d25294937bfc38b3649d866e89ac8d730a1
后端代码（完成勋章）：https://github.com/Chef5/PopRun-b/commit/cc29a036fb1c7ba929047702919487e3b3a723fa

请求示例：

{
    "rid": 9
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": 9,
    "openid": "oZoB85ZonTk33GQC4iWxlsbh06UI",
    "nickname": "しiuyam",
    "team": null,
    "sex": "2",
    "img": "https://wx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLtLfzx8n8Xaswx5ebF522FgV7VE1FIMXiaPQ5B3WK9oQliabhMWgliaOhuNsXibNSP36uu3AouE91T3g/132",
    "info": null,
    "job": null,
    "created_at": "2020-03-11 19:57:21",
    "updated_at": "2020-03-11 19:57:21",
    "honors": {
      "rid": 9,
      "hoid": 2,
      "created_at": "2020-03-30 14:32:50",
      "updated_at": "2020-03-30 14:32:52",
      "desc": "lv1",
      "name": "草鞋"
    },
    "medals": [
      {
        "linkid": 1,
        "rid": 9,
        "meid": 3,
        "created_at": "2020-03-30 14:40:30",
        "updated_at": "2020-03-30 14:40:32",
        "mkey": "star_3_act",
        "type": 0,
        "name": "3星跑者",
        "desc": "单次运动里程达15km",
        "img": "http://dev.run.nunet.cn/resources/medals/star_3_act.png"
      }
    ]
  }
}

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ openid	string	非必须
├─ nickname	null	非必须
├─ team	null	非必须
├─ sex	null	非必须
├─ img	null	非必须
├─ info	null	非必须
├─ job	null	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ honors	object	非必须
├─ rid	number	非必须
├─ hoid	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ desc	string	非必须
├─ name	string	非必须
├─ medals	object []	非必须	item 类型: object
├─ linkid	number	必须
├─ rid	number	必须
├─ meid	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ mkey	string	必须
├─ type	number	必须
├─ name	string	必须
├─ desc	string	必须
├─ img	string	必须

修改个人信息

基本信息

Path： /api/user/doUpdate

Method： POST

接口描述：

修改头像时，需要调用上传头像接口/user/uploadImg，获取到上传的头像url
openid和rid任意一个均可以，同时传也没有问题

https://github.com/Chef5/PopRun-b/commit/3f62229a6f80a67e421b14a0792337704c0bedca

请求参数

Headers

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

Body

名称	类型	是否必须
rid	number	必须
openid	string	必须
nickname	string	非必须
sex	string	非必须
img	string	非必须
team	string	非必须
info	string	非必须
job	string	非必须

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ openid	string	非必须
├─ nickname	string	非必须
├─ sex	string	非必须
├─ img	string	非必须
├─ team	string	非必须
├─ info	string	非必须
├─ job	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

获取个人运动数据统计

基本信息

Path： /api/user/getMyRunsData

Method： GET

接口描述：

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "times": 2,
    "sumD": "286.40",
    "maxD": "45.00",
    "sumT": "1333332",
    "maxT": 666666,
    "avgS": "12355.00",
    "maxS": "12355",
    "minS": "12355"
  }
}

请求参数

Query

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

返回数据

名称	类型	是否必须	备注
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ times	number	非必须	总次数
├─ sumD	string	非必须	总里程
├─ maxD	string	非必须	单次最大里程
├─ sumT	string	非必须	总运动时间
├─ maxT	number	非必须	单次最大时间
├─ avgS	string	非必须	平均速度
├─ maxS	string	非必须	最大平均速度
├─ minS	string	非必须	最小平均速度

获取已获勋章

基本信息

Path： /api/user/getMedal

Method： POST

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/0bebc94aa0d087602dad10a61ae1b0d23071d802

请求示例：

{
    "rid": 4
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "linkid": 1,
      "rid": 4,
      "meid": 7,
      "created_at": "2020-03-21 20:34:45",
      "updated_at": "2020-03-21 20:34:48",
      "mkey": "star_2_act",
      "type": 0,
      "name": "2星跑者",
      "desc": "单次运动里程达10km",
      "img": "http://127.0.0.1:8000/resources/medals/star_2_act.png"
    },
    {
      "linkid": 2,
      "rid": 4,
      "meid": 19,
      "created_at": "2020-03-21 20:35:03",
      "updated_at": "2020-03-21 20:35:05",
      "mkey": "2020_06",
      "type": 0,
      "name": "2020.06",
      "desc": "您2020.06累计跑步7次，授予您2020.06月活跃勋章",
      "img": "http://127.0.0.1:8000/resources/medals/2020_06.png"
    },
    {
      "linkid": 3,
      "rid": 4,
      "meid": 31,
      "created_at": "2020-03-21 20:35:15",
      "updated_at": "2020-03-21 20:35:19",
      "mkey": "rank_b",
      "type": 1,
      "name": "白银",
      "desc": "您在上月累计里程在校区前10名，授予您一枚白银勋章",
      "img": "http://127.0.0.1:8000/resources/medals/rank_b.png"
    },
    {
      "linkid": 4,
      "rid": 4,
      "meid": 31,
      "created_at": "2020-03-21 20:35:27",
      "updated_at": "2020-03-21 20:35:29",
      "mkey": "rank_b",
      "type": 1,
      "name": "白银",
      "desc": "您在上月累计里程在校区前10名，授予您一枚白银勋章",
      "img": "http://127.0.0.1:8000/resources/medals/rank_b.png"
    }
  ]
}

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须	item 类型: object
├─ linkid	number	必须
├─ rid	number	必须
├─ meid	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ mkey	string	必须
├─ type	number	必须
├─ name	string	必须
├─ desc	string	必须
├─ img	string	必须

获取已获称号

基本信息

Path： /api/user/getHonor

Method： POST

接口描述：

获取某用户已获得称号（升序）：按获得时间先后顺序
后端代码：https://github.com/Chef5/PopRun-b/commit/1bf21d2b4c4f9a0786f133f7b0da7e4c880d8765

请求示例：

{
    "rid": 31
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": [
    {
      "rid": 31,
      "hoid": 19,
      "created_at": "2020-03-14 22:35:48",
      "updated_at": "2020-03-14 22:35:48",
      "desc": "lv0",
      "name": "赤脚"
    },
    {
      "rid": 31,
      "hoid": 20,
      "created_at": "2020-03-14 22:56:39",
      "updated_at": "2020-03-14 22:56:43",
      "desc": "lv1",
      "name": "草鞋"
    }
  ]
}

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须	备注	其他信息
isSuccess	boolean	非必须
msg	string	非必须
data	object []	非必须	升序	item 类型: object
├─ rid	number	必须
├─ hoid	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ desc	string	必须
├─ name	string	必须

获取隐私设置（个人主页访问权限）

基本信息

Path： /api/user/getProvicy

Method： GET

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/c80d2b4ed53728084ed2aa02b0acc153c5409a8f

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": 6,
    "job": 1,
    "team": 1,
    "run": 1,
    "created_at": "2020-04-15 19:28:07",
    "updated_at": "2020-04-15 19:28:07"
  }
}

请求参数

Query

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

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ job	number	非必须
├─ team	number	非必须
├─ run	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

隐私设置

基本信息

Path： /api/user/doSettings

Method： POST

接口描述：

隐私设置：0不可见，1（初始默认）可见
后端代码：

请求示例：

{
  "rid": 2,
  "job": 1,
  "team": 0,
  "run": 1
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": 2,
    "job": 1,
    "team": 0,
    "run": 1,
    "created_at": "2020-04-13 12:58:41",
    "updated_at": "2020-04-13 19:35:23"
  }
}

请求参数

Headers

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

Body

名称	类型	是否必须	备注
rid	integer	必须
job	integer	非必须	职业：0不可见，1可见
team	integer	非必须	校区：0不可见，1可见
run	integer	非必须	运动数据：0不可见，1可见

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ job	number	非必须
├─ team	number	非必须
├─ run	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

隐私设置-重置

基本信息

Path： /api/user/resetSettings

Method： POST

接口描述：

隐私设置重置功能，将设置全部恢复为默认（1可见）
后端代码：https://github.com/Chef5/PopRun-b/commit/497415ebd73a708b27bd8c51a9d606c599f7c8a0

请求示例：

{
  "rid": 2
}

返回示例：

{
  "isSuccess": true,
  "msg": "操作成功",
  "data": {
    "rid": 2,
    "job": 1,
    "team": 1,
    "run": 1,
    "created_at": "2020-04-13 19:44:21",
    "updated_at": "2020-04-13 19:44:21"
  }
}

请求参数

Headers

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

Body

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

返回数据

名称	类型	是否必须
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ rid	number	非必须
├─ job	number	非必须
├─ team	number	非必须
├─ run	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

后台管理 api/admin/

上传勋章图标

基本信息

Path： /api/admin/uploadMedal

Method： POST

接口描述：

注意：此传输格式为form，图片存储路径在resources/medals

后端代码：https://github.com/Chef5/PopRun-b/commit/b8e3bbce562eafa68696ce4e64b5ec089f16c110

返回示例：

{
    "isSuccess": true,
    "msg": "上传成功",
    "data": {
        "mkey": "rank_a",
        "type": "1",
        "name": "青铜",
        "desc": "恭喜获得青铜",
        "img": "http://127.0.0.1:8000/resources/medals/rank_a.png",
        "updated_at": "2020-03-21 18:57:41",
        "created_at": "2020-03-21 18:57:41",
        "meid": 5
    }
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
img	file	是
mkey	text	是	rank_a	检索串，不能和已有重复
type	text	是	0	0不可重复获得，1可以重复获得
name	text	是	青铜	勋章名称
desc	text	是	校区前100名，授予您一枚青铜勋章	勋章描述

返回数据

名称	类型	是否必须	备注
isSuccess	boolean	非必须
msg	string	非必须
data	object	非必须
├─ mkey	string	非必须	唯一检索串
├─ type	string	非必须	0不可重复，1可重复
├─ name	string	非必须
├─ desc	string	非必须
├─ img	string	非必须
├─ updated_at	string	非必须
├─ created_at	string	非必须
├─ meid	number	非必须	id

数据库初始化[慎用]

基本信息

Path： /api/admin/initData

Method： GET

接口描述：

后端代码：https://github.com/Chef5/PopRun-b/commit/b73ec3faab38c7ca91a119662ff246919006cec5

请求参数

Query

参数名称	是否必须	示例	备注
key	是	123123
data	是	honors	honors称号、medals勋章

返回数据

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

数据库转移：图片

基本信息

Path： /api/admin/transferImg

Method： POST

接口描述：

keyType：moment, activity

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
key	string	必须		管理密码
keyType	string	必须		过渡表key

返回数据

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

定时任务测试（非接口）

季勋章授予

基本信息

Path： /api/test/grantSeasonMedal

Method： GET

接口描述：

请求参数

月勋章授予

基本信息

Path： /api/test/grantMonthMedal

Method： GET

接口描述：

请求参数

月排行榜勋章授予

基本信息

Path： /api/test/grantRankingMedal

Method： GET

接口描述：

请求参数

称号授予

基本信息

Path： /api/test/grantHonor

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	其他信息
type	object []	非必须	item 类型: object
├─ port	string []	必须	item 类型: string
├─		非必须
├─ obj	string []	必须	item 类型: string
├─		非必须

YAPI 接口文档

跑鸭

公共信息

跑鸭

相关链接

接口说明

数据长度说明

环境说明

E-R

全局接口 api/main/

上传图片

基本信息

请求参数

返回数据

删除通知

基本信息

请求参数

返回数据

用户授权注册

基本信息

请求参数

返回数据

获取openid

基本信息

请求参数

返回数据

获取token（后期加）

基本信息

请求参数

返回数据

获取勋章列表

基本信息

请求参数

返回数据

获取称号列表

基本信息

请求参数

返回数据

获取系统通知

基本信息

请求参数

返回数据

阅读通知

基本信息

请求参数

返回数据

动态圈子 api/moments/

点赞

基本信息

请求参数

返回数据

删除动态

基本信息

请求参数

返回数据

发布动态

基本信息

请求参数

返回数据

发表评论

基本信息

请求参数

返回数据

取消点赞

基本信息

请求参数

返回数据

删除评论

基本信息

请求参数

返回数据

获取个人动态

基本信息

请求参数

返回数据

获取动态

基本信息

请求参数

返回数据

获取广告（暂不实现）