评论模块接口文档

一、新增评论

1、基本信息:

请求路径:/comment
请求方式:PUT
接口描述:该接口用于用户对商家进行评论

2、请求参数:
请求参数格式:application/x-www-form-urlencoded

参数名称 说明 类型 是否必须 备注
store_id 商家ID number
commentary 评论内容 String

3、请求样例:

{
    "store_id":1,
    "commentary":"他卖的都是假货"

}

4、响应数据:
响应类型:applicaytion/json
响应参数说明:

参数名称 类型 是否必须 默认值 备注 其他信息
code number 响应码,0-成功,1-失败
message String 提示信息
data String 返回的数据

响应数据样例:

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间: 09:34:34.266720300 来自于 MiniShopping "
}

二、查询评论

1、基本信息:

请求路径:/comment/search
请求方式:GET
接口描述:该接口用于商家或用户查询评论

2、请求参数:
请求参数格式:params

参数名称 说明 类型 是否必须 备注
user_id 用户ID number
store_id 商家ID number

3、请求样例:

~/comment?store_id=1&pageNum=1&pageSize=1

4、响应数据:
响应类型:applicaytion/json
响应参数说明:

参数名称 类型 是否必须 默认值 备注 其他信息
code number 响应码,0-成功,1-失败
message String 提示信息
data String 返回的数据

响应数据样例:

{
    "code": 0,
    "massage": "操作成功",
    "data": {
        "total": 3,
        "list": [
            {
                "id": 2,
                "user_id": 1,
                "store_id": 1,
                "commentary": "他卖的都是假货",
                "create_time": "2024-11-17 09:34:31",
                "update_time": "2024-11-17 09:34:31"
            }
        ]
    }
}

三、评论删除

1、基本信息:

请求路径:/comment
请求方式:DELETE
接口描述:该接口用于用户删除评论

2、请求参数:
请求参数格式:application/x-www-form-urlencoded

参数名称 说明 类型 是否必须 备注
id 评论主键ID number

3、请求样例:

~/comment?id=2

4、响应数据:
响应类型:applicaytion/json
响应参数说明:

参数名称 类型 是否必须 默认值 备注 其他信息
code number 响应码,0-成功,1-失败
message String 提示信息
data String 返回的数据

响应数据样例:

{
    "code": 0,
    "massage": "操作成功",
    "data": "当前时间: 11:58:12.472482600 来自于 MiniShopping "
}
posted @ 2024-11-17 11:59  许凌铎  阅读(7)  评论(0编辑  收藏  举报