Files
a-share-analysis/docs/features/FEAT-MO-004-index-sector-detail/requirements.md
T

1.2 KiB
Raw Blame History

FEAT-MO-004 需求与约束

功能需求

  • FR-001:提供指数详情 HTTP API。
  • FR-002:提供一级行业板块详情 HTTP API。
  • FR-003:详情 API 只接受登记代码、period=1d 和 1..120 的 count。
  • FR-004:详情响应包含 K 线序列、报价、交易日期、状态、来源和警告。
  • FR-005:概览指数和板块按钮导航到详情页,详情页可返回概览。
  • FR-006:分时仅在 TDX 探测通过后启用,未启用时返回 intraday=false。

非功能需求

  • NFR-001:TDX 原始异常和地址不得暴露给 Web。
  • NFR-002:本机 TDX 可达时详情首屏 P95 目标小于 2 秒;不可达时 10 秒内返回不可用状态。
  • NFR-003:详情请求失败不影响首页五个概览模块。
  • NFR-004:API asOf 使用 UTC ISO,Web 使用 Asia/Shanghai 展示。
  • NFR-005:前端请求只能经过 Axios 封装,后端 DTO 作为 OpenAPI 契约来源。

约束判断

消息、数据库、Redis、Scheduler、Worker 和部署配置无需同步修改;详情为只读实时查询,不产生异步任务或持久化数据。OpenAPI、Web API、前端路由、测试和文档需要同步更新。