前景说明:这个版本是自己参考之前整理的 肯定是有不足忘大神补充
具体正文格式如下:
某某项目微信小程序接口(项目名称+详细说明)
1.项目根路径
http://ip:port/根路径名称
2.状态码说明
序号 | 状态码 | 说明 |
1 | 200 | 访问正常 |
2 | 404 | 访问异常 |
3 | 403 | 访问异常 |
4 | 500 | 接口异常 |
3.接口
3.1 商品模块
3.1.1查询商品
- 请求路径:selectCommodityList
- 请求方法:GET
- 请求参数
参数名 | 参数说明 | 备注 |
pageSize | 每页显示多少 | 【可选参数】不传则获取所有 |
pageNum | 当前页码 | 【可选参数】不传则获取所有 |
- 响应参数
参数名 | 参数说明 | 备注 |
comId | 商品数据id | |
comName | 商品名称 |
- 响应数据
{
"code": 200,
"msg": "查询成功",
"data": [{
"comId": 1,
"comName": "水果"
}]
}