新增接口及接口文档

2026-04-27 00:32:09 +08:00
parent 7a7e28684c
commit ee1707c17f
10 changed files with 830 additions and 2 deletions
@@ -0,0 +1,56 @@
+# 交易日历接口文档
+
+## 1. 接口说明
+
+- 接口名称：交易日历
+- 请求方式：`GET`
+- 请求路径：`/api/v1/common/trade-calendar`
+- 接口用途：获取上交所开市交易日列表，并返回当前数据中的最大交易日。
+
+## 2. 请求参数
+
+无
+
+请求示例：
+
+```http
+GET /api/v1/common/trade-calendar
+```
+
+## 3. 响应说明
+
+| 字段名 | 类型 | 说明 |
+| --- | --- | --- |
+| `open_dates` | `array[string]` | 全部开市日期列表，格式 `YYYY-MM-DD` |
+| `max_date` | `string` | 开市日期列表中的最大日期 |
+
+## 4. 响应示例
+
+```json
+{
+  "open_dates": [
+    "2026-04-20",
+    "2026-04-21",
+    "2026-04-22",
+    "2026-04-23",
+    "2026-04-24"
+  ],
+  "max_date": "2026-04-24"
+}
+```
+
+## 5. 业务规则
+
+- 只返回 `trade_calendar` 表中 `exchange = 'SSE'` 且 `is_open = 1` 的交易日。
+- 日期按升序返回。
+- `max_date` 等于列表中的最后一个日期。
+
+## 6. 错误响应
+
+服务端异常时：
+
+```json
+{
+  "error": "具体错误信息"
+}
+```