其他 API
模块: others
本模块包含 17 个API端点。
📋 端点列表
- 🔍
GET /- Root - 🔍
GET /health- Health Check - 🔍
GET /redis/status- Redis Status - 🔍
GET /redis/test- Redis Test - 🔍
GET /api/v1/me- Get Current User Info - ➕
POST /api/v1/logout- Logout - 🔍
GET /api/v1/channel-presets/presets- Get Presets - 🔍
GET /api/v1/channel-presets/presets/{preset_id}- Get Preset Detail - ➕
POST /api/v1/channel-presets/validate- Validate Channel Config - 🔍
GET /api/v1/indicators/- Get All Indicators - 🔍
GET /api/v1/indicators- Get All Indicators - 🔍
GET /api/v1/indicators/{indicator_id}- Get Indicator - 🔍
GET /api/v1/data-sync/status- Get Data Sync Status - ➕
POST /api/v1/data-sync/{symbol}/start- Start Symbol Sync - ➕
POST /api/v1/data-sync/{symbol}/stop- Stop Symbol Sync - ➕
POST /api/v1/data-sync/start- Start Data Sync Service - ➕
POST /api/v1/data-sync/stop- Stop Data Sync Service
📖 详细说明
🔍 Root
请求方式: GET /
响应:
🔍 Health Check
健康检查端点
请求方式: GET /health
响应:
🔍 Redis Status
Redis状态检查
请求方式: GET /redis/status
响应:
🔍 Redis Test
Redis测试端点
请求方式: GET /redis/test
响应:
🔍 Get Current User Info
获取当前用户信息
请求方式: GET /api/v1/me
响应:
➕ Logout
用户登出
请求方式: POST /api/v1/logout
响应:
🔍 Get Presets
获取所有预设模板列表
Returns: PresetListResponse: 包含所有可用预设模板的信息
请求方式: GET /api/v1/channel-presets/presets
响应:
// 参考模型: PresetListResponse
- `presets` (array) - **必填** -
- `total` (integer) - **必填** -
🔍 Get Preset Detail
获取预设模板详细配置（返回带注释的原始JSON）
Args: preset_id: 预设模板ID (aggressive-momentum, balanced-multi, conservative-value)
Returns: Response: 包含注释的原始JSON内容
请求方式: GET /api/v1/channel-presets/presets/{preset_id}
路径参数:
preset_id(string) - 必填 -
响应:
错误响应:
422: Validation Error
➕ Validate Channel Config
验证通道配置是否有效
Args: request: 包含通道配置列表的验证请求
Returns: ConfigValidationResponse: 验证结果，包含错误和警告信息
请求方式: POST /api/v1/channel-presets/validate
请求体:
// 参考模型: ConfigValidationRequest
- `channels` (array) - **必填** - 通道配置列表
响应:
// 参考模型: ConfigValidationResponse
- `valid` (boolean) - **必填** -
- `errors` (array) - 可选 -
- `warnings` (array) - 可选 -
错误响应:
422: Validation Error
🔍 Get All Indicators
获取所有技术指标元数据列表
Returns: 所有指标的元数据列表
请求方式: GET /api/v1/indicators/
响应:
// 数组: IndicatorMetadata[]
- `id` (string) - **必填** -
- `name_cn` (string) - **必填** -
- `name_en` (string) - **必填** -
- `category` (string) - **必填** -
- `description` (object) - **必填** -
- 类型: `IndicatorDescription`
- `parameters` (array) - **必填** -
- `outputs` (array) - **必填** -
- `pandas_ta` (object) - 可选 -
- `usage_notes` (object) - 可选 -
- `related_indicators` (object) - 可选 -
- `version` (string) - **必填** -
🔍 Get All Indicators
获取所有技术指标元数据列表
Returns: 所有指标的元数据列表
请求方式: GET /api/v1/indicators
响应:
// 数组: IndicatorMetadata[]
- `id` (string) - **必填** -
- `name_cn` (string) - **必填** -
- `name_en` (string) - **必填** -
- `category` (string) - **必填** -
- `description` (object) - **必填** -
- 类型: `IndicatorDescription`
- `parameters` (array) - **必填** -
- `outputs` (array) - **必填** -
- `pandas_ta` (object) - 可选 -
- `usage_notes` (object) - 可选 -
- `related_indicators` (object) - 可选 -
- `version` (string) - **必填** -
🔍 Get Indicator
获取单个技术指标详情
Args: indicator_id: 指标 ID（如 rsi, macd, bollinger_bands）
Returns: 指标详细信息
Raises: 404: 指标不存在
请求方式: GET /api/v1/indicators/{indicator_id}
路径参数:
indicator_id(string) - 必填 -
响应:
// 参考模型: IndicatorMetadata
- `id` (string) - **必填** -
- `name_cn` (string) - **必填** -
- `name_en` (string) - **必填** -
- `category` (string) - **必填** -
- `description` (object) - **必填** -
- 类型: `IndicatorDescription`
- `parameters` (array) - **必填** -
- `outputs` (array) - **必填** -
- `pandas_ta` (object) - 可选 -
- `usage_notes` (object) - 可选 -
- `related_indicators` (object) - 可选 -
- `version` (string) - **必填** -
错误响应:
422: Validation Error
🔍 Get Data Sync Status
获取 DataSyncService 状态
返回当前同步状态、已订阅的标的、回看天数等信息
请求方式: GET /api/v1/data-sync/status
响应:
// 参考模型: DataSyncStatusResponse
- `sync_state` (string) - **必填** - 同步状态
- `subscribed_symbols` (array) - 可选 - 已订阅的股票代码
- `lookback_days` (integer) - 可选 - 历史数据回看天数
- `last_sync_time` (object) - 可选 - 最后同步时间
- `subscription_counts` (object) - 可选 - 各标的订阅计数
➕ Start Symbol Sync
启动指定标的的数据同步
如果服务未启动，会自动启动服务
请求方式: POST /api/v1/data-sync/{symbol}/start
路径参数:
symbol(string) - 必填 -
请求体:
// 参考模型: StartSyncRequest
- `symbols` (array) - 可选 - 要订阅的股票代码列表
- `session_id` (string) - **必填** - 会话 ID
响应:
// 参考模型: StartSyncResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 响应消息
- `sync_state` (string) - **必填** - 当前同步状态
错误响应:
422: Validation Error
➕ Stop Symbol Sync
停止指定标的的数据同步
实际是取消订阅，当引用计数为 0 时才真正取消
请求方式: POST /api/v1/data-sync/{symbol}/stop
路径参数:
symbol(string) - 必填 -
请求体:
// 参考模型: api__v1__endpoints__data_sync__SubscribeRequest
- `session_id` (string) - **必填** - 会话 ID
响应:
// 参考模型: StopSyncResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 响应消息
错误响应:
422: Validation Error
➕ Start Data Sync Service
启动 DataSyncService
启动数据同步服务，开始同步所有已订阅的标的
请求方式: POST /api/v1/data-sync/start
响应:
// 参考模型: StartSyncResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 响应消息
- `sync_state` (string) - **必填** - 当前同步状态
➕ Stop Data Sync Service
停止 DataSyncService
停止数据同步服务
请求方式: POST /api/v1/data-sync/stop
响应:
// 参考模型: StopSyncResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 响应消息