Files
MediaCrawler/docs
butubb 556680c613
Deploy VitePress site to Pages / build (push) Canceled after 0s
Deploy VitePress site to Pages / Deploy (push) Canceled after 0s
docs: API 接口清单(从 OpenAPI schema 生成)
58 个接口,按 auth/crawler/creator/data/monitor/settings 分组,逐条列出方法、路径、
是否需要登录、说明、参数(含类型/必填/默认)、请求体 schema;附录展开请求体的字段。

**生成的,不是手写的** —— 手写的接口文档从改代码那天起就开始腐烂,而且烂得无声无息。
`docs/gen_api_doc.py` 只读 app 对象,不连库不起服务。

两处值得说的:

* 鉴权**不能从 schema 里读** —— require_auth 是普通依赖不是 security scheme,不会进
  OpenAPI 的 security 字段。所以那份「哪些路径免登录」的名单是照着 include_router
  核的,而且 auth 那一组不能一刀切(/me 和 /password 各自另有保护)。
* 生成完**顺手验一遍表格**:参数类型里的 `integer | null` 到处是,一个没转义的竖线
  就会把整张表切歪,而 markdown 不报错、只是安静地多一格。验过这个检查确实会拦。

接口的响应没有结构可列 —— 它们返回普通 dict,没声明 response_model。
2026-10-12 08:50:53 +08:00
..
2026-03-24 09:52:30 +08:00
2026-10-05 22:21:13 +08:00
2025-08-01 01:05:11 +08:00
2025-11-06 00:08:03 +08:00
2026-01-19 12:23:04 +08:00
2025-06-20 16:10:44 +08:00
2026-03-24 09:52:30 +08:00