Update README

xuan25 · Jun 10, 2021 · 0bcc718 · 0bcc718
1 parent b738a58
commit 0bcc718
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 3 deletions.
diff --git a/BiliOnlineRank/BiliOnlineRank/BiliOnlineRank.csproj b/BiliOnlineRank/BiliOnlineRank/BiliOnlineRank.csproj
@@ -61,7 +61,7 @@
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="RSAUtil\RSAEncrypter.cs" />
-    <Compile Include="ServiceProvider.cs" />
+    <Compile Include="ApiProvider.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="App.config" />

diff --git a/README.md b/README.md
@@ -20,14 +20,44 @@
 1       50      <hide>
 -------- 在线用户 --------
 -        0      <hide>
-在线人数: 1
+在线人数: 2
 
 
 排名    贡献值  用户名
 -------- 高能榜 --------
 1       50      <hide>
 -------- 在线用户 --------
 -        0      <hide>
-在线人数: 1
+在线人数: 2
 
 ```
+
+## 本地服务
+
+支持通过本地 API 访问数据，默认地址为 `http://localhost:8000`
+
+### /data
+
+路径 `/data` 接收 `GET` 请求，无参数，返回 `json` 数据，示例如下：
+
+```
+{
+    "number": 2,
+    "gold_rank": [
+        {
+            "uid": <hide>,
+            "uname": "<hide>",
+            "face": "http://i2.hdslb.com/bfs/face/<hide>.jpg",
+            "rank": 1,
+            "score": 50
+        }
+    ],
+    "online_rank": [
+        {
+            "uid": <hide>,
+            "uname": "<hide>",
+            "face": "http://i2.hdslb.com/bfs/face/<hide>.jpg",
+        }
+    ]
+}
+```