update: docs
This commit is contained in:
31
docs/project-book/chapters/appendix-a-api.tex
Normal file
31
docs/project-book/chapters/appendix-a-api.tex
Normal file
@@ -0,0 +1,31 @@
|
||||
% ============================================================
|
||||
% 附录 A:API 端点一览
|
||||
% ============================================================
|
||||
|
||||
\chapter{API 端点一览}
|
||||
\label{app:api}
|
||||
|
||||
\begin{table}[H]
|
||||
\centering
|
||||
\caption{系统主要 API 端点}
|
||||
\begin{tabular}{lll}
|
||||
\toprule
|
||||
\textbf{端点} & \textbf{方法} & \textbf{功能} \\
|
||||
\midrule
|
||||
/api/v1/cases & GET, POST & 案件列表 / 创建 \\
|
||||
/api/v1/cases/\{id\} & GET, PATCH & 案件详情 / 更新 \\
|
||||
/api/v1/cases/\{id\}/images & GET, POST & 截图列表 / 上传 \\
|
||||
/api/v1/images/\{id\} & GET & 截图详情 + OCR 结果 \\
|
||||
/api/v1/cases/\{id\}/analyze & POST & 触发分析 \\
|
||||
/api/v1/cases/\{id\}/transactions & GET & 交易列表 \\
|
||||
/api/v1/cases/\{id\}/flows & GET & 资金流图 \\
|
||||
/api/v1/cases/\{id\}/assessments & GET & 认定列表 \\
|
||||
/api/v1/assessments/\{id\}/review & POST & 提交复核 \\
|
||||
/api/v1/cases/\{id\}/inquiry-suggestions & GET & 问询建议 \\
|
||||
/api/v1/cases/\{id\}/reports & GET, POST & 报告列表 / 生成 \\
|
||||
/api/v1/reports/\{id\}/download & GET & 下载报告 \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
|
||||
API 文档可通过访问 \texttt{/docs} 获取交互式 Swagger 文档。
|
||||
Reference in New Issue
Block a user