API 文档

版本: 1.0.0

用于量化交易股票的后端API服务

🗂️ 模块组织

API按功能模块组织，每个模块都有独立的文档目录：

📁 API测试

模块: api-test

端点数量: 25 个

• ➕ POST /api/v1/api-test/pull/static-info - Test Static Info
• ➕ POST /api/v1/api-test/pull/quote - Test Quote
• ➕ POST /api/v1/api-test/pull/depth - Test Depth
• ➕ POST /api/v1/api-test/pull/trades - Test Trades
• ➕ POST /api/v1/api-test/pull/intraday - Test Intraday
• … 还有 20 个端点

📁 资产管理

模块: assets

端点数量: 13 个

• 🔍 GET /api/v1/assets/ - Get User Asset
• ✏️ PUT /api/v1/assets/ - Update User Asset
• ➕ POST /api/v1/assets/ - Create User Asset
• 🗑️ DELETE /api/v1/assets/ - Delete User Asset
• 🔍 GET /api/v1/assets/overview - Get Asset Overview
• … 还有 8 个端点

📁 认证

模块: authentication

端点数量: 2 个

• ➕ POST /api/v1/login - Login
• ➕ POST /api/v1/settings/longport/refresh-token - Refresh Longport Token

📁 券商管理

模块: brokers

端点数量: 15 个

• 🔍 GET /api/v1/brokers - Get All Brokers
• ➕ POST /api/v1/brokers - Create Broker
• 🔍 GET /api/v1/brokers/{broker_id} - Get Broker
• ✏️ PUT /api/v1/brokers/{broker_id} - Update Broker
• 🗑️ DELETE /api/v1/brokers/{broker_id} - Delete Broker
• … 还有 10 个端点

📁 其他

模块: others

端点数量: 19 个

• 🔍 GET / - Root
• 🔍 GET /health - Health Check
• 🔍 GET /redis/status - Redis Status
• 🔍 GET /redis/test - Redis Test
• 🔍 GET /api/v1/me - Get Current User Info
• … 还有 14 个端点

📁 风险管理

模块: risk

端点数量: 6 个

• 🔍 GET /api/v1/risk/presets - Get Risk Presets
• 🔍 GET /api/v1/risk/presets/{preset_name} - Get Risk Preset By Name
• 🔍 GET /api/v1/risk/default - Get Default Risk Config
• 🔍 GET /api/v1/risk/conservative - Get Conservative Risk Config
• 🔍 GET /api/v1/risk/aggressive - Get Aggressive Risk Config
• … 还有 1 个端点

📁 系统配置

模块: settings

端点数量: 6 个

• 🔍 GET /api/v1/settings/data-source - Get Data Source Config
• ✏️ PUT /api/v1/settings/data-source - Update Data Source Config
• 🔍 GET /api/v1/settings/longport - Get Longport Config
• ✏️ PUT /api/v1/settings/longport - Update Longport Config
• 🔍 GET /api/v1/settings/asset-mode - Get Asset Mode
• … 还有 1 个端点

📁 股票数据

模块: stocks

端点数量: 8 个

• ➕ POST /api/v1/stock-data - Create Stock Data
• 🔍 GET /api/v1/stock-data - Get Stock Data List
• 🔍 GET /api/v1/stock-data/{code}/{timestamp} - Get Stock Data
• 🔍 GET /api/v1/stock-codes - Get Stock Codes
• 🗑️ DELETE /api/v1/stock-data/{code} - Delete Stock Data
• … 还有 3 个端点

📁 策略管理

模块: strategies

端点数量: 10 个

• 🔍 GET /api/v1/custom-templates/strategies/list - List Strategies
• 🔍 GET /api/v1/custom-templates/strategies/{template_name}/versions - Get Strategy Versions
• 🔍 GET /api/v1/custom-templates/strategies/{template_name}/latest - Get Latest Strategy Version
• 🔍 GET /api/v1/strategies/ - Get Available Strategies List
• 🔍 GET /api/v1/strategies/{strategy_name} - Get Strategy Info
• … 还有 5 个端点

📁 交易管理

模块: trading

端点数量: 59 个

• 🔍 GET /api/v1/assets/positions - Get User Positions
• ➕ POST /api/v1/assets/positions - Create User Position
• ✏️ PUT /api/v1/assets/positions/{position_id} - Update User Position
• 🗑️ DELETE /api/v1/assets/positions/{position_id} - Delete User Position
• 🔍 GET /api/v1/assets/simulated/positions - Get Simulated Positions
• … 还有 54 个端点

📁 用户管理

模块: users

端点数量: 6 个

• 🔍 GET /api/v1/users - Get All Users
• ➕ POST /api/v1/users - Create User
• 🔍 GET /api/v1/users/{user_id} - Get User
• ✏️ PUT /api/v1/users/{user_id} - Update User
• 🗑️ DELETE /api/v1/users/{user_id} - Delete User
• … 还有 1 个端点

总计: 11 个模块, 169 个端点

---

🚀 快速开始

认证

所有API请求都需要JWT认证（除了登录端点）。

# 1. 登录获取token
curl -X POST "http://localhost:8000/api/v1/login" \
  -H "Content-Type: application/json" \
  -d '{"username": "your_username", "password": "your_password"}'

# 2. 使用token访问API
curl -X GET "http://localhost:8000/api/v1/..." \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

基础URL

• 开发环境: http://localhost:8000
• API版本: v1
• 基础路径: /api/v1

---

📚 相关文档

• OpenAPI规范 - 完整的API规范
• 开发指南 - 后端开发指南
• 架构文档 - 系统架构文档

---

生成时间: 由 scripts/generate_docs.sh 自动生成