Skip to main content

Module server

Module server 

Source
Expand description

REST API HTTP 服务

使用 axum 构建,复用 OpenD 的 RequestRouter 处理请求。 支持 WebSocket 推送: 客户端连接 /ws 可接收实时行情和交易推送。

Structs§

RestAdminHooks
REST admin/diagnostic extension hooks injected by futu-opend.

Functions§

build_router_with_auth
构建 REST API 路由,携带 KeyStore 做 Bearer Token 鉴权 + RuntimeCounters 做限额
build_router_with_auth_and_admin
v1.4.32+ 扩展:额外传入 admin_status_provider,/api/admin/status 用。 旧 build_router_with_auth 内部委托到此,admin_status_provider = None 时行为与之前完全一致(admin_status endpoint 返 503)。 push_health_snapshot_provider 同理只在 full-admin hooks 入口注入; 未注入时 /api/push-subscriber-info 返 503,避免把 wiring 缺口伪装成 ret_type=0 的真实健康快照。
build_router_with_auth_full_admin
v1.4.32+ 完整扩展:同时接 status provider + reload handler。
start_with_auth
启动 REST API 服务,挂载 KeyStore 做 Bearer Token 鉴权 + RuntimeCounters 做限额。
start_with_auth_and_admin
v1.4.32+ 同 start_with_auth,但额外接 admin_status_provider。 让 /api/admin/status 能返回实时健康快照。 push_health_snapshot_provider 仍需走 start_with_auth_full_admin 注入; 未注入时 /api/push-subscriber-info loud-fail 503。
start_with_auth_full_admin
v1.4.32+ 完整 admin 入口:同时接 status provider + reload handler。
start_with_auth_full_admin_until_shutdown
start_with_auth_full_admin,但支持 daemon 统一 shutdown 信号。