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
构建 REST API 路由(无鉴权,向后兼容)
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)。
build_router_with_auth_full_admin
v1.4.32+ 完整扩展:同时接 status provider + reload handler。
start
启动 REST API 服务,返回 WsBroadcaster 供外部推送事件
start_with_auth
start_with_broadcaster,但挂载 KeyStore 做 Bearer Token 鉴权 + RuntimeCounters 做限额
start_with_auth_and_admin
v1.4.32+ 同 start_with_auth,但额外接 admin_status_provider。 让 /api/admin/status 能返回实时健康快照。
start_with_auth_full_admin
v1.4.32+ 完整 admin 入口:同时接 status provider + reload handler。
start_with_broadcaster
启动 REST API 服务并返回 WsBroadcaster(供外部推送系统使用)