Add project metadata and docs

新增工具文档/猫眼电影实时票房排行.md

@@ -0,0 +1,180 @@
+好的，这是为您整理的猫眼电影实时票房排行接口对接文档，可直接用于指导AI编程助手进行开发。
+
+
+
+\### 猫眼电影实时票房排行 - 接口对接文档
+
+
+
+\#### 接口概览
+
+本接口用于获取猫眼电影最新的实时票房排行数据，返回当天热门电影的票房、排片、上座率等关键指标。
+
+
+
+\#### 请求地址
+
+`https://api.pearapi.ai/api/maoyan/`
+
+
+
+\#### 请求方式
+
+GET
+
+
+
+\#### 返回格式
+
+JSON
+
+
+
+\#### 权限/付费要求
+
+免费接口，无需付费或特殊权限。
+
+
+
+\#### 请求参数说明
+
+无。该接口为GET请求，无需任何请求参数。
+
+
+
+\#### 默认请求示例
+
+```json
+
+{}
+
+```
+
+
+
+\#### 返回字段说明
+
+返回数据为JSON对象，包含顶层字段和嵌套在`data`字段中的数组。`data`字段是一个数组，每个元素代表一部电影的票房数据。
+
+
+
+| 字段路径 | 类型 | 说明 |
+
+| :--- | :--- | :--- |
+
+| `code` | integer | 状态码，通常200表示成功。 |
+
+| `msg` | string | 状态信息，例如“success”。 |
+
+| `time` | string | 当前时间。 |
+
+| `data` | array | 票房排行列表，包含多个电影对象。 |
+
+| `data\[].top` | integer | 排行，例如1、2、3。 |
+
+| `data\[].movieName` | string | 电影名。 |
+
+| `data\[].releaseInfo` | string | 上映天数，例如“上映6天”。 |
+
+| `data\[].sumBoxDesc` | string | 总票房，例如“2.53亿”。 |
+
+| `data\[].boxRate` | string | 票房占比，例如“42.5%”。 |
+
+| `data\[].showCount` | integer | 排场次数。 |
+
+| `data\[].showCountRate` | string | 排片占比，例如“35.2%”。 |
+
+| `data\[].avgShowView` | string | 场均人次。 |
+
+| `data\[].avgSeatView` | string | 上座率，例如“12.3%”。 |
+
+
+
+\#### 返回示例
+
+由于原始配置中未提供示例结果，以下是根据字段说明构造的示例，实际返回数据可能略有差异。
+
+```json
+
+{
+
+  "code": 200,
+
+  "msg": "success",
+
+  "time": "2024-05-20 14:30:00",
+
+  "data": \[
+
+    {
+
+      "top": 1,
+
+      "movieName": "示例电影A",
+
+      "releaseInfo": "上映6天",
+
+      "sumBoxDesc": "2.53亿",
+
+      "boxRate": "42.5%",
+
+      "showCount": 123456,
+
+      "showCountRate": "35.2%",
+
+      "avgShowView": "45",
+
+      "avgSeatView": "12.3%"
+
+    },
+
+    {
+
+      "top": 2,
+
+      "movieName": "示例电影B",
+
+      "releaseInfo": "上映13天",
+
+      "sumBoxDesc": "1.87亿",
+
+      "boxRate": "28.1%",
+
+      "showCount": 98765,
+
+      "showCountRate": "28.5%",
+
+      "avgShowView": "38",
+
+      "avgSeatView": "10.1%"
+
+    }
+
+  ]
+
+}
+
+```
+
+
+
+\#### 对接注意事项
+
+1\.  \*\*无参数请求\*\*：直接对请求地址发起GET请求即可，无需拼接任何查询参数。
+
+2\.  \*\*数据解析\*\*：请注意`data`字段是一个数组，需要遍历获取每部电影的排行数据。
+
+3\.  \*\*字段类型\*\*：`showCount`为整数类型，其余数字相关字段（如`boxRate`、`showCountRate`）为字符串类型，其中可能包含“%”等符号，在需要进行数学计算时需先进行字符串处理。
+
+
+
+\#### 给AI助手的实现建议
+
+1\.  \*\*发起请求\*\*：使用HTTP客户端库（如Python的`requests`、JavaScript的`axios`或`fetch`）对 `https://api.pearapi.ai/api/maoyan/` 发起一个不带任何body和params的GET请求。
+
+2\.  \*\*错误处理\*\*：检查返回的`code`字段是否为200。如果不是，可以根据`msg`字段进行错误提示。
+
+3\.  \*\*数据提取\*\*：成功获取数据后，从返回的JSON对象中提取`data`数组，然后遍历该数组，按需求提取`top`、`movieName`、`sumBoxDesc`等字段。
+
+4\.  \*\*数据展示\*\*：由于`boxRate`、`showCountRate`等字段是包含百分号的字符串，如果需要在图表中展示或进行排序，建议先转换为浮点数。
+