Skip to content

Commit 0db4954

Browse files
committed
<doc>(api): update usage in readme
1 parent 5f71e8f commit 0db4954

2 files changed

Lines changed: 2913 additions & 780 deletions

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,15 @@ npm run lint
236236
- PDF 上传成功后文件默认保存在 `backend/app/media/uploads/`,可通过 `/api/v1/papers/uploads/{paper_id}/parse` 提交 MinerU 解析任务。
237237
- 解析结果命中缓存时会直接返回,未命中时由 Celery Worker 调用 MinerU 并将 JSON 结果写入 `parsed_paper_cache`,后续同一文件解析将直接复用。
238238
- 批注接口 `/api/v1/papers/uploads/{paper_id}/annotations` 支持高亮与文本批注,前端 PDF Viewer 会实时展示。
239+
- 后端启动后可访问 API 文档:`http://localhost:8000/docs`(Swagger UI)/ `http://localhost:8000/redoc`(ReDoc),OpenAPI Schema:`http://localhost:8000/openapi.json`
240+
241+
导出 OpenAPI 文件(生成 `openapi.json`,便于前端/测试工具对接):
242+
243+
```bash
244+
python backend/export_openapi.py
245+
# 或指定输出路径
246+
python backend/export_openapi.py --output doc/openapi.json
247+
```
239248

240249
前端调用示例可参考 `frontend/src/lib/api-client.ts``frontend/src/app` 中的页面实现。
241250

@@ -364,4 +373,4 @@ npm run dev
364373
365374
```bash
366375
docker exec -it insightreading-postgres-1 psql -U postgres -d papers -c "DELETE FROM uploaded_papers; DELETE FROM papers; DELETE FROM parsed_paper_cache; DELETE FROM mineru_parse_jobs;"
367-
```
376+
```

0 commit comments

Comments
 (0)