jie65535/gc-opencommand-plugin
1
0
Fork 0
mirror of https://github.com/jie65535/gc-opencommand-plugin.git synced 2025-12-15 19:31:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
方块君
2022-07-22 23:03:25 +08:00
parent a4048d4fd1
commit 37dcd0f1a7
2 changed files with 154 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
README_en-US.md
View File

@@ -73,27 +73,84 @@ public final class JsonResponse {
}
```
## Actions
### `ping`
data = null
### Actions
#### `Test connect`
### `sendCode`
#### Request
data = uid (int)
#### Response
data = token (string)
##### Request
### `verify`: Requires `token`
#### Request
data = code (int)
#### Response
##### Success:
code = 200
##### Verification failed:
code = 400
| Request | Request data | type |
| ------- | -------------- | ------ |
| action | `ping` |`String`|
### `command`: Requires `token`
#### Request
data = command (string)
#### Response
data = message (string)
##### Response
| Response | Response data | type |
| -------- | --------------- | ------ |
| retcode | `200` |`String`|
| message | `success` |`String`|
| data | `null` |`null` |
#### `Send code`
##### Request
| Request | Request data | type |
| ------- | -------------- | ------ |
| action | `sendCode` |`String`|
| data | `uid` |`Int` |
##### Response
| Response | Response data | type |
| -------- | --------------- | ------ |
| retcode | `200` |`String`|
| message | `success` |`String`|
| data | `token` |`String`|
#### `Verify code`
##### Request
| Request | Request data | type |
| ------- | -------------- | ------ |
| action | `verify` |`String`|
| token | `token` |`String`|
| data | `code` |`Int` |
##### Response
Success
| Response | Response data | type |
| -------- | -------------- | ------ |
| retcode | `200` |`String`|
| message | `success` |`String`|
| data | `null` | `null` |
Failed
| Response | Response data | type |
| -------- | -------------------- | ------ |
| retcode | `400` |`String`|
| message | `Verification failed`|`String`|
| data | `null` |`null` |
#### `Run command`
##### Request
| Request | Request data | type |
| ------- | -------------- | ------ |
| action | `command` |`String`|
| token | `token` |`String`|
| data | `command` |`String`|
##### Response
Success
| Response | Response data | type |
| -------- | ------------------ | ------ |
| retcode | `200` |`String`|
| message | `success` |`String`|
| data | `Command return` |`String`|