Update README.md

README.md

@@ -9,9 +9,9 @@ pinned: false
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
-# Ochinpo API 路由详细文档
+# 文档（含参数样例）
 
-本接口文档涵盖 `ochinpo-api` 服务所有路由，参数说明、请求方式、返回示例等内容。该服务基于 Node.js + Express，支持多种文件、媒体相关操作。
+本接口文档包括参数说明、请求方式、返回示例与实际请求样例。该服务基于 Node.js + Express，支持多种文件、媒体相关操作。
 
 ---
 
@@ -20,6 +20,12 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
 - **方法**：GET/POST/任意
 - **功能**：返回服务状态信息
 - **请求参数**：无
+- **请求样例**：
+
+  ```
+  GET https://yourdomain/
+  ```
+
 - **返回示例**：
   ```json
   {
@@ -44,16 +50,58 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
 - **方法**：GET/POST
 - **路径**：`/brat` 或 `/carbon`
 - **功能**：生成 Brat 风格图片或 Carbon 代码图片
+
+### `/brat`
+
 - **请求参数**：
-  - `/brat`：`text`（待生成文本，必填）
-  - `/carbon`：`code` 或 `text`（必填）
-  - 通用可选：`json`（返回 JSON 结果）、`raw`（返回原始文件）
+  - `text`（待生成文本，必填）
+  - 可选：`json`（返回 JSON 结果）、`raw`（返回原始文件）
+
+- **请求样例**：
+
+  ```
+  GET https://yourdomain/brat?text=cat&json=true
+  ```
+
 - **返回**：
-  - 成功：JSON 或重定向到图片
+  - 成功：
     ```json
     { "success": true, "result": "https://yourdomain/file/randomname.jpg" }
     ```
-  - 失败：HTTP 400/500
+  - 失败：
+    ```json
+    { "success": false, "message": "Required parameter 'text'" }
+    ```
+
+---
+
+### `/carbon`
+
+- **请求参数**：
+  - `code` 或 `text`（必填，代码内容）
+  - 可选：`json`、`raw`
+
+- **请求样例**：
+
+  ```
+  POST https://yourdomain/carbon
+  Content-Type: application/json
+
+  {
+    "code": "console.log('Hello World!');",
+    "json": true
+  }
+  ```
+
+- **返回**：
+  - 成功：
+    ```json
+    { "success": true, "result": "https://yourdomain/file/randomname.png" }
+    ```
+  - 失败：
+    ```json
+    { "success": false, "message": "Required parameter 'code'" }
+    ```
 
 ---
 
@@ -62,9 +110,17 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
 - **方法**：GET/POST
 - **路径**：`/mediafire`
 - **功能**：获取 Mediafire 文件信息和下载地址
+
 - **请求参数**：
   - `url`（Mediafire 文件地址，必填）
   - 可选：`debug`（调试信息）
+
+- **请求样例**：
+
+  ```
+  GET https://yourdomain/mediafire?url=https://www.mediafire.com/file/abcdefg/sample.txt&json=true
+  ```
+
 - **返回**：
   - 成功：
     ```json
@@ -73,14 +129,17 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
       "result": {
         "cookie": "...",
         "download": "https://downloadlink",
-        "name": "filename",
+        "name": "sample.txt",
         "size": "1.2 MB",
         "content": "...",
-        ...
+        // 其他文件信息
       }
     }
     ```
-  - 失败：参数错误、暂不支持文件夹下载
+  - 失败：
+    ```json
+    { "success": false, "message": "Invalid url" }
+    ```
 
 ---
 
@@ -89,15 +148,35 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
 - **方法**：POST
 - **路径**：`/topdf`
 - **功能**：将图片 URL 列表合成一个 PDF 文件
+
 - **请求参数**（body）：
   - `images`（图片 URL 数组或单个 URL，必填）
   - 可选：`json`、`raw`
+
+- **请求样例**：
+
+  ```
+  POST https://yourdomain/topdf
+  Content-Type: application/json
+
+  {
+    "images": [
+      "https://yourdomain/file/a.jpg",
+      "https://yourdomain/file/b.jpg"
+    ],
+    "json": true
+  }
+  ```
+
 - **返回**：
-  - 成功：JSON 或重定向到 PDF 文件
+  - 成功：
     ```json
     { "success": true, "result": "https://yourdomain/file/randomname.pdf" }
     ```
-  - 失败：图片无效、转换失败
+  - 失败：
+    ```json
+    { "success": false, "message": "Can't convert to pdf" }
+    ```
 
 ---
 
@@ -106,15 +185,32 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
 - **方法**：POST
 - **路径**：`/webp2gif`、`/webp2mp4`、`/webp2png`
 - **功能**：WebP 图片（base64）转 gif/mp4/png 格式
+
 - **请求参数**（body）：
-  - `file`（base64 格式 WebP 图片，必填）
+  - `file`（WebP 图片的 base64 字符串，必填）
   - 可选：`json`、`raw`
+
+- **请求样例**：
+
+  ```
+  POST https://yourdomain/webp2png
+  Content-Type: application/json
+
+  {
+    "file": "<base64字符串>",
+    "json": true
+  }
+  ```
+
 - **返回**：
-  - 成功：JSON 或重定向到新文件
+  - 成功：
     ```json
-    { "success": true, "result": "https://yourdomain/file/randomname.gif" }
+    { "success": true, "result": "https://yourdomain/file/randomname.png" }
+    ```
+  - 失败：
+    ```json
+    { "success": false, "message": "Invalid base64 format" }
     ```
-  - 失败：参数错误、base64格式无效
 
 ---
 
@@ -125,21 +221,76 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
   - `/yt/search` 或 `/youtube/search`：搜索视频
   - `/yt/dl` `/yt/download` `/youtube/dl` `/youtube/download`：下载音频/视频
   - `/yt` `/youtube`：获取视频信息及下载链接
+
+### 搜索接口
+
 - **请求参数**：
-  - 搜索：
-    - `query`（关键词或视频ID，必填）
-  - 下载：
-    - `url`（YouTube 视频地址，必填）
-    - `type`（`audio` 或 `video`，可选，默认音频）
-    - `quality`（音质/画质，默认128/720）
+  - `query`（关键词或视频ID，必填）
+
+- **请求样例**：
+
+  ```
+  GET https://yourdomain/yt/search?query=cat&json=true
+  ```
+
 - **返回**：
-  - 搜索成功：
+  - 成功：
     ```json
     { "success": true, "result": { ...视频信息... } }
     ```
-  - 下载：
-    - 成功重定向到下载地址，或返回下载链接
-    - 失败：返回错误 JSON
+  - 失败：
+    ```json
+    { "success": false, "message": "Video unavailable" }
+    ```
+
+---
+
+### 下载接口
+
+- **请求参数**：
+  - `url`（YouTube 视频地址，必填）
+  - 可选：`type`（`audio` 或 `video`，默认音频）、`quality`（音质/画质）
+
+- **请求样例**：
+
+  ```
+  GET https://yourdomain/yt/dl?url=https://youtu.be/xxxxxxxxxxx&type=audio&json=true
+  ```
+
+- **返回**：
+  - 成功：重定向或返回下载链接
+  - 失败：
+    ```json
+    { "success": false, "message": "Invalid url" }
+    ```
+
+---
+
+### 视频信息及下载链接
+
+- **请求参数**：
+  - `query`（关键词或视频ID，必填）
+
+- **请求样例**：
+
+  ```
+  GET https://yourdomain/yt?query=https://youtu.be/xxxxxxxxxxx&json=true
+  ```
+
+- **返回**：
+  - 成功：
+    ```json
+    {
+      "success": true,
+      "result": {
+        ...视频信息...,
+        "download": {
+          "audio": "https://yourdomain/yt/dl?url=https://youtu.be/xxxxxxxxxxx&type=audio",
+          "video": "https://yourdomain/yt/dl?url=https://youtu.be/xxxxxxxxxxx&type=video"
+        }
+      }
+    }
+    ```
 
 ---
 
@@ -148,6 +299,13 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
 - **方法**：GET
 - **路径**：`/file/<filename>`
 - **功能**：访问由 API 生成的临时文件（图片、PDF等）
+
+- **请求样例**：
+
+  ```
+  GET https://yourdomain/file/randomname.png
+  ```
+
 - **返回**：文件内容
 
 ---
@@ -160,3 +318,5 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
 - 所有接口均有参数校验和错误提示，便于前端或脚本调用。
 
 ---
+
+如需某个接口的详细用例或更深入参数说明，请继续留言！