From f2b57df19fd14f50a39d45daa01bbd1403e976fc Mon Sep 17 00:00:00 2001
From: sjfhsjfh <sjfhsjfh@qq.com>
Date: Sat, 16 Mar 2024 21:42:42 +0800
Subject: [PATCH] doc: add report api documentation

---
 README.md |  4 +++
 report.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 86 insertions(+)
 create mode 100644 report.md

diff --git a/README.md b/README.md
index 249a11d..8db30f7 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,10 @@
 [![resonance-market](https://img.shields.io/endpoint?url=https://pages.onekuma.cn/project/resonance-market&label=在线访问)](https://resonance.breadio.wiki/)
 [![CI](https://github.com/yjl9903/resonance-market/actions/workflows/ci.yml/badge.svg)](https://github.com/yjl9903/resonance-market/actions/workflows/ci.yml)
 
+## 数据上报接口文档
+
+见 [此处](./report.md)
+
 ## 本地运行 或 开发测试 / Run locally or Development Test
 
 请确保已安装 [git] 和 [pnpm]。
diff --git a/report.md b/report.md
new file mode 100644
index 0000000..693d775
--- /dev/null
+++ b/report.md
@@ -0,0 +1,82 @@
+# 数据上报格式
+
+## 单次上传
+
+在 `${url}/api/log` 这一 endpoint 上, 接受 POST 请求，请求体为 JSON 格式的对象, 包含以下字段:
+
+```JSON
+{
+    "name": ProductName,
+    "sourceCity": CityName,
+    "targetCity": CityName,
+    "type": "buy" | "sell",
+    "trend": "up" | "same" | "down",
+    "price": number,
+    "percent": number,
+    "uploadedAt": number
+}
+```
+
+其中 `ProductName` 为商品名称, `CityName` 为城市名称, 可在 [全商品表格](./scripts/全商品统计.csv) 中查看
+
+`price` 为价格(整数), `percent` 为价格显示百分比(例如 `112`, 而非 `1.2`), `uploadedAt` 为上传 UNIX 时间戳, 单位为毫秒
+
+以下为一个示例
+
+```JSON
+{
+    "name": "防弹背心",
+    "percent": 110,
+    "price": 3225,
+    "sourceCity": "铁盟哨站",
+    "targetCity": "修格里城",
+    "trend": "up",
+    "type": "sell",
+    "uploadedAt": 1710595468922
+}
+```
+
+### 响应
+
+预期响应为 `200 OK`, 响应体为
+
+```JSON
+{
+    "count": 1
+}
+```
+
+## 批量上传
+
+在 `${url}/api/logs` 这一 endpoint 上, 接受 POST 请求，请求体为 JSON 格式的列表, 列表中每一个对象与单次上传的格式相同:
+
+```JSON
+[
+    {
+        "name": ProductName,
+        "sourceCity": CityName,
+        "targetCity": CityName,
+        "type": "buy" | "sell",
+        "trend": "up" | "same" | "down",
+        "price": number,
+        "percent": number,
+        "uploadedAt": number
+    },
+    ...
+]
+```
+
+各字段含义与单次上传相同
+
+### 响应
+
+预期响应为 `200 OK`, 响应体为
+
+```JSON
+{
+    "count": number
+}
+```
+
+其中 `count` 为成功上传的数据条数
+