28 lines
680 B
Markdown
28 lines
680 B
Markdown
|
---
|
||
|
|
title: HTTP API Reference
|
||
|
|
---
|
||
|
|
|
||
|
|
# HTTP API Reference
|
||
|
|
|
||
|
|
本页为占位文档，用于满足应用在 `@parent/docs/references/http_api_reference.md` 的导入依赖。
|
||
|
|
|
||
|
|
> 说明：`@parent` 在 `ragflow_web/.umirc.ts` 中被设置为仓库根目录（`path.resolve(__dirname, '../')`）。
|
||
|
|
> 因此此文件路径应位于仓库根的 `docs/references/http_api_reference.md`。
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
这里将列出后端提供的 HTTP API 端点、请求参数、响应结构以及示例。
|
||
|
|
|
||
|
|
示例：
|
||
|
|
|
||
|
|
```
|
||
|
|
GET /api/v1/health
|
||
|
|
|
||
|
|
Response:
|
||
|
|
{
|
||
|
|
"status": "ok",
|
||
|
|
"version": "0.21.1"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
后续可将真实内容迁移或同步到此处，以便文档与前端导入路径保持一致。
|