前端操作觀測

文件狀態:架構規範
最後驗證:2026-05-14
來源:只能操作前端、沒有前端 repo code 時的 Network log 觀測需求

這裡放什麼

這個區塊用來記錄「前端頁面 / 使用者操作 / 實際打出的 API」之間的關係。

適用情境:

  • 沒有前端程式碼,只能從瀏覽器操作和 DevTools Network 觀察。
  • 要知道某個頁面會打哪些 API。
  • 要知道某支 API 被哪些頁面或操作使用。
  • 要整理 migration / LB 切流前後,前端實際行為是否符合預期。

不放什麼

  • 不放一次性 session token、完整 JWT、驗證碼、個資。
  • 不取代 API 業務流程文件。
  • 不取代 專案 migration detail。
  • 不把所有 Network requests 無篩選地倒進來。

資料模型

頁面 Page
-> 操作 Operation
-> API Detail

三者分工:

類型回答問題位置
頁面 Page這是哪頁、怎麼進入、有哪些可操作項目頁面/
操作 Operation使用者怎麼點、打哪些 API、成功/失敗畫面如何判斷;這是主要觀測文件操作/
API Detail這支 API 的 method/path/request/response、routing、side effect、被哪些頁面與操作使用API/

案例 Case 只放一次性驗證與排查摘要。穩定知識要回填到 Page / Operation / API Detail,不要長期維護重複內容。

正向與反向關聯

正向關聯由文件內的 Obsidian wikilink 建立:

頁面 -> 操作 -> API Detail

反向關聯用兩種方式取得:

  1. Obsidian Backlinks:從 API Detail 看哪些頁面 / 操作連到它。
  2. API Detail 內手動維護「出現位置」區塊。

API Detail 內建議固定寫:

## 出現位置
 
- 頁面:[[../頁面/...]]
- 操作:[[../操作/...]]

命名規則

頁面

頁面/<產品區域>__<頁面_slug>.md

例:

頁面/staging__pro_search_cleaning.md
頁面/dashboard__works_detail.md

操作

操作/<流程>__<動作>.md

例:

操作/quote_bid__submit_review.md
操作/search_add__submit_request.md

API Detail

API/<METHOD>__<path_slug>.md

path slug 規則:

  • / 改成 __
  • {id} 或實際 id 改成語意參數
  • .json 保留在標題,不一定放在檔名

例:

API/POST__quote_bids__change_status__reviews__quote_bid_id.md
API/POST__quote_requests__search_add.md

建議觀測流程

  1. 開 DevTools Network。
  2. 勾選 Preserve log。
  3. 勾選 Disable cache。
  4. 清空 Network。
  5. 從頁面初始狀態開始操作。
  6. 每次操作只做一件事。
  7. 記錄 API 順序、method、path、status、response body。
  8. 將敏感資訊遮蔽後再貼進文件。
  9. 若同一 API 在不同頁面出現,更新 API Detail 的「出現位置」。

紀錄粒度

建議只記錄會影響業務或 migration 的 API:

  • 會寫 DB 的 POST / PUT / PATCH / DELETE。
  • 會影響頁面狀態判斷的 GET。
  • CORS / LB / origin 切流相關 API。
  • response shape 對前端重要的 API。

可以忽略:

  • GA / GTM / pixel。
  • 靜態資源。
  • 重複 polling,除非它影響狀態判斷。
  • browser extension request。

安全規則

貼 curl 或 header 前必須處理:

  • X-PRO360-User-Session-Token:遮蔽或只保留末 4 碼。
  • JWT / id_token:不要貼完整值。
  • 手機、email:非測試帳號要遮蔽。
  • 驗證碼:不要記錄。
  • Cookie:不要貼完整值。

和其他文件的關係

目前資料夾

資料夾用途
頁面/README前端頁面與畫面入口
操作/README使用者操作與 API sequence
READMEAPI detail 頁
案例/README實際觀測案例
附件/README截圖、HAR 摘要等輔助素材放置規則