Update docs

Arcaea-Infinity · Oct 22, 2022 · e4105f4 · e4105f4
1 parent 5f3ecd5
commit e4105f4
Show file tree

Hide file tree

Showing 21 changed files with 400 additions and 277 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/.idea/
diff --git a/README.md b/README.md
@@ -16,25 +16,32 @@ For the deploy tutorial of AUA, please refer to [How to deploy AUA](/deploy.md).
 
 ### API Entry
 
-+ [user/info](/user/userinfo.md)
-+ [user/best](/user/userbest.md)
-+ [user/best30](/user/userbest30.md)
++ [user/info](/user/info.md)
++ [user/best](/user/best.md)
++ [user/best30](/user/best30.md)
 
 
-+ [song/info](/song/songinfo.md)
-+ [song/list](/song/songlist.md)
-+ [song/alias](/song/songalias.md)
-+ [song/random](/song/songrandom.md)
++ [song/info](/song/info.md)
++ [song/list](/song/list.md)
++ [song/alias](/song/alias.md)
++ [song/random](/song/random.md)
 
 
-+ [assets/icon](/assets/iconassets.md)
-+ [assets/char](/assets/charassets.md)
-+ [assets/song](/assets/songassets.md)
++ [assets/icon](/assets/icon.md)
++ [assets/char](/assets/char.md)
++ [assets/song](/assets/song.md)
++ [assets/preview](/assets/preview.md) [^1]
 
 
 + [data/update](/data/update.md)
 + [data/theory](/data/theory.md)
 + [data/playdata](/data/playdata.md)
++ [data/density](/data/density.md)
++ [data/challenge](/data/challenge.md) [^2]
+
+[^1]: The `assets/preview` API is not available for release version of AUA. It is provided by [AffPreview](https://github.com/Arcaea-Infinity/Aff2Preview).
+
+[^2]: The `data/challenge` API is not available for release version of AUA.
 
 ### Error status
 

diff --git a/assets/charassets.md → assets/char.md b/assets/charassets.md → assets/char.md
@@ -1,5 +1,7 @@
 ## assets/char
 
+> Note: It is not recommended to use this API frequently.
+
 | arguments | description                  | optional |
 |:----------|:-----------------------------|----------|
 | partner   | partner id                   | false    |

diff --git a/assets/iconassets.md → assets/icon.md b/assets/iconassets.md → assets/icon.md
@@ -1,5 +1,7 @@
 ## assets/icon
 
+> Note: It is not recommended to use this API frequently.
+
 | arguments | description                  | optional |
 |:----------|:-----------------------------|----------|
 | partner   | partner id                   | false    |

diff --git a/assets/preview.md b/assets/preview.md
@@ -0,0 +1,23 @@
+## assets/preview
+
+> Note: It is not recommended to use this API frequently.
+
+| arguments  | description                          | optional                                        |
+|:-----------|:-------------------------------------|-------------------------------------------------|
+| songname   | any song name for fuzzy querying     | true when songid is not null, otherwise false   |
+| songid     | sid in Arcaea songlist               | true when songname is not null, otherwise false |
+| difficulty | accept format are 3 or byn or beyond | true                                            |
+
+###### Tag
+
+* Enable Cors
+
+#### Example
+
++ `{apiurl}/botarcapi/assets/preview?songid=ifi`
+
+###### Content-Type
+
+```
+image/png
+```
diff --git a/assets/songassets.md → assets/song.md b/assets/songassets.md → assets/song.md
@@ -1,5 +1,7 @@
 ## assets/song
 
+> Note: It is not recommended to use this API frequently.
+
 | arguments  | description                                                        | optional                                                  |
 |:-----------|:-------------------------------------------------------------------|-----------------------------------------------------------|
 | songname   | any song name for fuzzy querying                                   | true when songid or file is not null, otherwise false     |

diff --git a/data/challenge.md b/data/challenge.md
@@ -0,0 +1,41 @@
+## data/challenge
+
+> Note: It is designed for the release version of AUA, and not available for the release version.
+
+| arguments | description         | optional                |
+|:----------|:--------------------|-------------------------|
+| path      | request arcapi path | false                   |
+| body      | request body        | true when body is empty |
+| time      | request timestamp   | true                    |
+
+#### Allowed pathes
+
+```json5
+[
+  "auth/login",
+  "user",
+  "user/me",
+  "friend/me/delete",
+  "friend/me/add",
+  "score/song/friend",
+  "purchase/me/stamina/fragment",
+  "world/map/me"
+]
+```
+
+###### Tag
+
+* Need Token
+
+#### Example
+
++ `{apiurl}/botarcapi/data/challenge?path=auth/login`
+
+##### Return data (Edited for readability)
+
+```json5
+{
+  "status": 0,
+  "content": "JfdDAIQBAAAkdLOHw7PyRfWyhkJvH1Xzfevm7quQMwOk5Lc99fD1vgesJ8uf5ZJgPfgtYlYGDu1FLk31AaNAYfGocKoRMMSAlqDc4y/aZxXCn4cGjnJ7ovR9rkCQG8W1sJ9cHuK4CDo="
+}
+```
diff --git a/data/density.md b/data/density.md
@@ -0,0 +1,42 @@
+## data/density
+
+> Note: It is a large data set, so it is not recommended to use this API frequently.
+
+| arguments  | description                          | optional                                                |
+|:-----------|:-------------------------------------|---------------------------------------------------------|
+| songname   | any song name for fuzzy querying     | true when songid or file is not null, otherwise false   |
+| songid     | sid in Arcaea songlist               | true when songname or file is not null, otherwise false |
+| difficulty | accept format are 3 or byn or beyond | true                                                    |
+
+###### Tag
+
+* Enable Cors
+
+#### Example
+
++ `{apiurl}/botarcapi/data/density?songid=ifi&difficulty=2`
+
+##### Return data (Edited for readability)
+
+```json5
+{
+  "status": 0,
+  "content": [
+    [
+      1000, // fscore, (score/10000)
+      115, // fpotential (potential/10)
+      1 // count
+    ],
+    [
+      1000,
+      116,
+      1
+    ],
+    [
+      1000,
+      117,
+      1
+    ]
+  ]
+}
+```
diff --git a/data/playdata.md b/data/playdata.md
@@ -1,4 +1,8 @@
-## playdata
+## data/playdata
+
+> Note: It is a large data set, so it is not recommended to use this API frequently.
+
+> Note: It is recommended to use `data/density` API.
 
 | arguments  | description                          | optional                                                |
 |:-----------|:-------------------------------------|---------------------------------------------------------|
@@ -16,14 +20,14 @@
 
 + `{apiurl}/botarcapi/data/playdata?songid=ifi&difficulty=2&start=1280&end=1288`
 
-##### Return data
+##### Return data (Edited for readability)
 
-```json
+```json5
 {
   "status": 0,
   "content": [
     {
-      "fscore": 1000,
+      "fscore": 1000, // (score/10000)
       "count": 125
     },
     {

diff --git a/data/theory.md b/data/theory.md
@@ -1,4 +1,4 @@
-## theory
+## data/theory
 
 | arguments    | description                                                                     | optional                                        |
 |:-------------|:--------------------------------------------------------------------------------|-------------------------------------------------|
@@ -17,7 +17,7 @@
 
 ##### Return data (Edited for readability)
 
-```json
+```json5
 {
   "status": 0,
   "content": {

diff --git a/data/update.md b/data/update.md
@@ -1,4 +1,4 @@
-## update
+## data/update
 
 ###### Tag
 
@@ -10,7 +10,7 @@
 
 ##### Return data
 
-```json
+```json5
 {
   "status": 0,
   "content": {

diff --git a/deploy.md b/deploy.md
@@ -10,15 +10,6 @@
 * (optional) add some nodes
 * start service
 
-### Nuget Packages Dependencies
-
-| PackageName                             | Version |
-|:----------------------------------------|:--------|
-| Microsoft.AspNetCore.Mvc.NewtonsoftJson | 6.0.1   |
-| sqlite-net-pcl                          | 1.7.335 |
-| Newtonsoft.Json                         | 13.0.1  |
-| Downloader                              | 2.3.5   |
-
 ### Configuration fields
 
 * config.json
@@ -63,7 +54,7 @@
   * ```bash
     socat -d TCP4-LISTEN:6161,reuseaddr,fork TCP4:arcapi-v2.lowiro.com:443
     ```
-  * It is highly recommended that set it as a background task using nohup, screen or whatever you like
+  * It is highly recommended that set it as a background task
 
 
 * Windows server

diff --git a/song/songalias.md → song/alias.md b/song/songalias.md → song/alias.md
@@ -1,5 +1,7 @@
 ## song/alias
 
+> Note: It is recommended to use `song/list` API as the local cache data source.
+
 | arguments  | description                                                                | optional                                        |
 |:-----------|:---------------------------------------------------------------------------|-------------------------------------------------|
 | songname   | any song name for fuzzy querying                                           | true when songid is not null, otherwise false   |
@@ -15,12 +17,12 @@
 
 ##### Return data
 
-```json
+```json5
 {
-    "status": 0,
-    "content": [
-        "色号",
-        "对立色"
-    ]
+  "status": 0,
+  "content": [
+    "色号",
+    "对立色"
+  ]
 }
 ```
diff --git a/song/songinfo.md → song/info.md b/song/songinfo.md → song/info.md
@@ -1,5 +1,7 @@
 ## song/info
 
+> Note: It is recommended to use `song/list` API as the local cache data source.
+
 | arguments  | description                                                                | optional                                        |
 |:-----------|:---------------------------------------------------------------------------|-------------------------------------------------|
 | songname   | any song name for fuzzy querying                                           | true when songid is not null, otherwise false   |
@@ -15,7 +17,7 @@
 
 ###### Return data
 
-```json
+```json5
 {
   "status": 0,
   "content": {

diff --git a/song/songlist.md → song/list.md b/song/songlist.md → song/list.md
@@ -1,5 +1,7 @@
 ## song/list
 
+> Note: It is a large data set, so it is not recommended to use this API frequently.
+
 ###### Tag
 
 * Enable Cors
@@ -10,7 +12,7 @@
 
 ###### Return data (Edited for readability)
 
-```json
+```json5
 {
   "status": 0,
   "content": {

diff --git a/song/songrandom.md → song/random.md b/song/songrandom.md → song/random.md
@@ -1,5 +1,7 @@
 ## song/random
 
+> Note: It is recommended to use `song/list` API as the local cache data source.
+
 | arguments    | description                                | optional |
 |:-------------|:-------------------------------------------|----------|
 | start        | range of start (9+ => 9p , 10+ => 10p)     | true     |
@@ -22,7 +24,7 @@ var val = rating * 2 + (ratingPlus ? 1 : 0);
 
 ###### Return data
 
-```json
+```json5
 {
   "status": 0,
   "content": {