nepiedg
2884f54666
- Revised README.md to provide a clearer documentation structure for multiple mini programs, including a new table of contents. - Added references to common authentication documentation in both the remove watermark API and README files. - Improved clarity of the login interface description and error handling messages in the remove watermark API documentation.
2.2 KiB
2.2 KiB
戒烟/抽烟记录 API
所有接口前缀：/api/v1/smoke
除登录外都需要：Authorization: Bearer <session_key>（见：docs/common/auth.md）
1) 新增记录
POST /api/v1/smoke/logs
请求体：
{
"smoke_time": "2025-12-31",
"remark": "压力大",
"level": 2,
"num": 3
}
说明：
smoke_time可选；不传则默认“当天”。level/num可选；不传或传<=0时会按1处理。
curl 示例：
curl -X POST 'http://127.0.0.1:8080/api/v1/smoke/logs' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer wx-session-key' \
-d '{"smoke_time":"2025-12-31","remark":"压力大","level":2,"num":3}'
成功响应示例（字段以实际为准）：
{
"code": 200,
"message": "success",
"data": {
"id": 5202,
"smoke_time": "2025-12-31T00:00:00+08:00",
"remark": "压力大",
"createtime": 1735600000,
"updatetime": 1735600000,
"deletetime": null,
"level": 2,
"num": 3
}
}
2) 获取单条记录
GET /api/v1/smoke/logs/:id
curl 示例：
curl -X GET 'http://127.0.0.1:8080/api/v1/smoke/logs/5202' \
-H 'Authorization: Bearer wx-session-key'
3) 列表查询（分页）
GET /api/v1/smoke/logs?page=1&page_size=20&start=2025-12-01&end=2025-12-31
参数：
page：页码，默认1page_size：每页数量，默认20，最大200start/end：可选，按smoke_time过滤（格式YYYY-MM-DD）
成功响应示例：
{
"code": 200,
"message": "success",
"data": {
"items": [],
"total": 0,
"page": 1,
"page_size": 20
}
}
4) 更新记录
PUT /api/v1/smoke/logs/:id
请求体（字段可选，按需传）：
{
"smoke_time": "2026-01-01",
"remark": "聚会",
"level": 3,
"num": 1
}
注意：
- 如果你想“清空 smoke_time”，请传空字符串：
{"smoke_time":""}。 - 如果传
null或者不传smoke_time，后端会认为你没有修改该字段。
5) 删除记录（软删除）
DELETE /api/v1/smoke/logs/:id
成功响应：
{
"code": 200,
"message": "success",
"data": {
"deleted": true
}
}