膳逸用户端：用户每日打卡模块（每日打卡、查询修改删除每日打卡信息、查询总共打卡天数）

膳逸

Base URLs:

• shanyi-api: http://localhost:8091/shanyi-api

Authentication

shanyi-api

POST 查询用户的打卡信息

POST /user/searchCheckInByPage

查询某一个关注的用户的打卡信息，可以按时间排序也可以默认由近到远，需要被关注的那个用户的id

Body 请求参数

{
  "page": 1,
  "length": 10,
  "userId": 5,
  "startTime": "",
  "endTime": "",
  "order": "desc"
}

请求参数

名称	位置	类型	必选	说明
Token	header	string	否	none
body	body	object	否	none
» page	body	integer	是	none
» length	body	integer	是	最小1，最大50
» userId	body	integer	是	要查询的那个用户的id
» startTime	body	string	否	none
» endTime	body	string	否	none
» order	body	string	是	按照打卡时间排序，desc或者asc

返回示例

成功

{
  "msg": "success",
  "result": {
    "totalCount": 2,
    "pageSize": 10,
    "totalPage": 1,
    "pageIndex": 1,
    "list": [
      {
        "images": "https://thirdwx.qlogo.cn/mmopen/vi_32/6ibtnStKibXDUTibnu052w40ps0DKqcUZBYaAiberiasgSsTGXwCLAicmXng2gE48ZnibYrmnPIiaVlNWjpCYiby85ibgM8Q/132",
        "user_id": 5,
        "nickName": "绊象",
        "name": "陈**",
        "time": "2024-07-11T18:40:02",
        "text": "今天打卡",
        "analysis": "暂无"
      },
      {
        "images": "https://thirdwx.qlogo.cn/mmopen/vi_32/6ibtnStKibXDUTibnu052w40ps0DKqcUZBYaAiberiasgSsTGXwCLAicmXng2gE48ZnibYrmnPIiaVlNWjpCYiby85ibgM8Q/132",
        "user_id": 5,
        "nickName": "绊象",
        "name": "陈**",
        "time": "2024-05-21T10:00:00",
        "text": "今天打卡",
        "analysis": "暂无"
      }
    ]
  },
  "code": 200
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» msg	string	true	none		none
» result	object	true	none		none
»» totalCount	integer	true	none		none
»» pageSize	integer	true	none		none
»» totalPage	integer	true	none		none
»» pageIndex	integer	true	none		none
»» list	[object]	true	none		none
»»» images	string	true	none		none
»»» user_id	integer	true	none		none
»»» nickName	string	true	none		none
»»» name	string	true	none		none
»»» time	string	true	none		none
»»» text	string	true	none		none
»»» analysis	string	true	none		none
» code	integer	true	none		none

POST 查询总共打卡多少天

POST /user/countMyCheckIn

查询自己总共打卡多少天

Body 请求参数

{
  "userId": 5
}

请求参数

名称	位置	类型	必选	说明
Token	header	string	否	none
body	body	object	否	none
» userId	body	integer	是	none

返回示例

成功

{
  "msg": "success",
  "result": 2,
  "code": 200
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» msg	string	true	none		none
» result	integer	true	none		none

POST 用户每日打卡

POST /user/checkIn

用户每日打卡

Body 请求参数

{
  "userId": 5,
  "text": "今天打卡测试",
  "time": "2024-05-24 08:16:46",
  "images": "https://lhplanet-1316168555.cos.ap-beijing.myqcloud.com/shanyi/development-documentation/development-documentation-v3.0.assets/202405241119574.png",
  "analysis": ""
}

请求参数

名称	位置	类型	必选	说明
Token	header	string	否	none
body	body	object	否	none
» userId	body	integer	是	none
» text	body	string	是	none
» time	body	string	是	none
» images	body	string	是	none

返回示例

成功

{
  "msg": "success",
  "code": 200
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	integer	true	none		none
» msg	string	true	none		none

POST 用户修改每日打卡信息

POST /user/updateCheckIn

Body 请求参数

{
  "checkInId": 1,
  "text": "修改打卡信息",
  "time": "2024-06-21 10:00:00",
  "images": "http://dummyimage.com/300x300"
}

请求参数

名称	位置	类型	必选	说明
Token	header	string	否	none
body	body	object	否	none
» checkInId	body	integer	是	none
» text	body	string	是	none
» time	body	string	是	none
» images	body	string	是	none

返回示例

200 Response

{
  "code": "string",
  "msg": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	string	true	none		none
» msg	string	true	none		none

POST 用户删除每日打卡信息

POST /user/deleteCheckIn

Body 请求参数

{
  "checkInId": 2
}

请求参数

名称	位置	类型	必选	说明
Token	header	string	否	none
body	body	object	否	none
» checkInId	body	integer	是	none

返回示例

200 Response

{
  "code": "string",
  "msg": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» code	string	true	none		none
» msg	string	true	none		none

数据模型