From 5c83ecd8dc347a842c302b0242ba34ccda06d7ed Mon Sep 17 00:00:00 2001
From: Zichao Lin <earthjasonlin@163.com>
Date: Sat, 25 Nov 2023 20:56:20 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20Home?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Home.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Home.md

diff --git a/Home.md b/Home.md
new file mode 100644
index 0000000..d170206
--- /dev/null
+++ b/Home.md
@@ -0,0 +1,67 @@
+## API 文档
+
+请求方式：GET
+
+接口路径：/api.php
+
+### 请求参数
+
+| 参数 | 类型 | 描述 |
+| --- | --- | --- |
+| id | 整数 | （可选）指定的记录编号。若不指定编号，则返回随机一条记录。 |
+
+### 响应字段说明
+
+| 字段名 | 类型   | 描述         |
+| ------ | ------ | ------------ |
+| code   | 整数   | 状态码   |
+| message| 字符串 | 响应消息     |
+| data   | 对象   | 数据 |
+
+- `code` 响应状态码：
+  - 0：成功
+  - 1：未找到记录
+  - 2：查询执行错误
+
+- `message` 响应消息，对响应状态码进行说明。
+
+- `data` 数据对象，包含以下字段：
+  - `id`：编号
+  - `title`：内容
+  - `author`：作者
+  - `from`：来源
+
+### 响应示例
+
+**成功响应示例**
+
+```json
+{
+    "code": 0,
+    "message": "OK",
+    "data": {
+        "id": 1,
+        "title": "内容",
+        "author": "作者",
+        "from": "来源"
+    }
+}
+```
+
+**失败响应示例**
+
+```json
+{
+    "code": 1,
+    "message": "No results found",
+    "data": null
+}
+```
+
+```json
+{
+    "code": 2,
+    "message": "Error executing query",
+    "data": null
+}
+```
\ No newline at end of file