37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# 接口文档总览
|
|
|
|
## 1. 基础说明
|
|
|
|
- 服务前缀：`/api/v1`
|
|
- 响应格式：`application/json`
|
|
- 当前项目接口总数：4
|
|
|
|
## 2. 接口列表
|
|
|
|
| 模块 | 方法 | 路径 | 说明 | 文档 |
|
|
| --- | --- | --- | --- | --- |
|
|
| 公共 | `GET` | `/api/v1/common/trade-calendar` | 获取交易日历 | [common-trade-calendar.md](./common-trade-calendar.md) |
|
|
| 股票分析 | `POST` | `/api/v1/stock/analyze` | 分析指定涨停日股票后续表现 | [stock-analyze.md](./stock-analyze.md) |
|
|
| 股票行情 | `GET` | `/api/v1/stock/kline/:code` | 获取指定股票历史 K 线 | [stock-kline.md](./stock-kline.md) |
|
|
| 涨停连板 | `GET` | `/api/v1/limit-board/overview` | 获取交易日涨停分组与近 30 日最高板趋势 | [limit-board-overview.md](./limit-board-overview.md) |
|
|
|
|
## 3. 错误响应约定
|
|
|
|
当前项目未统一封装错误码，接口错误响应以 `error` 字段返回文本信息。
|
|
|
|
示例：
|
|
|
|
```json
|
|
{
|
|
"error": "参数错误"
|
|
}
|
|
```
|
|
|
|
## 4. 跨域说明
|
|
|
|
服务已开启基础跨域头：
|
|
|
|
- `Access-Control-Allow-Origin: *`
|
|
- `Access-Control-Allow-Methods: POST, GET, OPTIONS`
|
|
- `Access-Control-Allow-Headers: Content-Type`
|