Update README.md

README.md

@@ -7,4 +7,156 @@ sdk: docker
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# Ochinpo API 路由详细文档
+
+本接口文档涵盖 `ochinpo-api` 服务所有路由，参数说明、请求方式、返回示例等内容。该服务基于 Node.js + Express，支持多种文件、媒体相关操作。
+
+---
+
+## 1. 根路径 `/`
+
+- **方法**：GET/POST/任意
+- **功能**：返回服务状态信息
+- **请求参数**：无
+- **返回示例**：
+  ```json
+  {
+    "message": "Hello World!",
+    "uptime": "00:03:22",
+    "status": {
+      "diskUsage": "123 MB",
+      "rss": "50.1 MB",
+      "heapTotal": "35.2 MB",
+      "heapUsed": "21.7 MB",
+      "external": "2.0 MB",
+      "arrayBuffers": "1.5 MB",
+      "memoryUsage": "2.5 GB / 4.0 GB"
+    }
+  }
+  ```
+
+---
+
+## 2. Carbon/Brat 图像生成 `/brat` 或 `/carbon`
+
+- **方法**：GET/POST
+- **路径**：`/brat` 或 `/carbon`
+- **功能**：生成 Brat 风格图片或 Carbon 代码图片
+- **请求参数**：
+  - `/brat`：`text`（待生成文本，必填）
+  - `/carbon`：`code` 或 `text`（必填）
+  - 通用可选：`json`（返回 JSON 结果）、`raw`（返回原始文件）
+- **返回**：
+  - 成功：JSON 或重定向到图片
+    ```json
+    { "success": true, "result": "https://yourdomain/file/randomname.jpg" }
+    ```
+  - 失败：HTTP 400/500
+
+---
+
+## 3. Mediafire 文件解析 `/mediafire`
+
+- **方法**：GET/POST
+- **路径**：`/mediafire`
+- **功能**：获取 Mediafire 文件信息和下载地址
+- **请求参数**：
+  - `url`（Mediafire 文件地址，必填）
+  - 可选：`debug`（调试信息）
+- **返回**：
+  - 成功：
+    ```json
+    {
+      "success": true,
+      "result": {
+        "cookie": "...",
+        "download": "https://downloadlink",
+        "name": "filename",
+        "size": "1.2 MB",
+        "content": "...",
+        ...
+      }
+    }
+    ```
+  - 失败：参数错误、暂不支持文件夹下载
+
+---
+
+## 4. 图片转 PDF `/topdf`
+
+- **方法**：POST
+- **路径**：`/topdf`
+- **功能**：将图片 URL 列表合成一个 PDF 文件
+- **请求参数**（body）：
+  - `images`（图片 URL 数组或单个 URL，必填）
+  - 可选：`json`、`raw`
+- **返回**：
+  - 成功：JSON 或重定向到 PDF 文件
+    ```json
+    { "success": true, "result": "https://yourdomain/file/randomname.pdf" }
+    ```
+  - 失败：图片无效、转换失败
+
+---
+
+## 5. WebP 格式转换 `/webp2gif` `/webp2mp4` `/webp2png`
+
+- **方法**：POST
+- **路径**：`/webp2gif`、`/webp2mp4`、`/webp2png`
+- **功能**：WebP 图片（base64）转 gif/mp4/png 格式
+- **请求参数**（body）：
+  - `file`（base64 格式 WebP 图片，必填）
+  - 可选：`json`、`raw`
+- **返回**：
+  - 成功：JSON 或重定向到新文件
+    ```json
+    { "success": true, "result": "https://yourdomain/file/randomname.gif" }
+    ```
+  - 失败：参数错误、base64格式无效
+
+---
+
+## 6. YouTube 相关 `/yt` `/youtube`
+
+- **方法**：GET/POST
+- **路径**：
+  - `/yt/search` 或 `/youtube/search`：搜索视频
+  - `/yt/dl` `/yt/download` `/youtube/dl` `/youtube/download`：下载音频/视频
+  - `/yt` `/youtube`：获取视频信息及下载链接
+- **请求参数**：
+  - 搜索：
+    - `query`（关键词或视频ID，必填）
+  - 下载：
+    - `url`（YouTube 视频地址，必填）
+    - `type`（`audio` 或 `video`，可选，默认音频）
+    - `quality`（音质/画质，默认128/720）
+- **返回**：
+  - 搜索成功：
+    ```json
+    { "success": true, "result": { ...视频信息... } }
+    ```
+  - 下载：
+    - 成功重定向到下载地址，或返回下载链接
+    - 失败：返回错误 JSON
+
+---
+
+## 7. 临时文件访问 `/file/<filename>`
+
+- **方法**：GET
+- **路径**：`/file/<filename>`
+- **功能**：访问由 API 生成的临时文件（图片、PDF等）
+- **返回**：文件内容
+
+---
+
+## 通用说明
+
+- `json` 参数为 true 时，强制返回 JSON 格式结果。
+- `raw` 参数为 true 时，直接返回文件内容，否则重定向到文件地址。
+- 所有文件下载/访问统一路径为 `/file/<filename>`。
+- 所有接口均有参数校验和错误提示，便于前端或脚本调用。
+
+---