jie65535/gc-opencommand-plugin
1
0
Fork 0
mirror of https://github.com/jie65535/gc-opencommand-plugin.git synced 2025-06-02 17:49:12 +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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
README.md
View File

@ -88,26 +88,84 @@ public final class JsonResponse {
``` ```
### Actions 动作 ### Actions 动作
#### `ping` #### `测试连接`
data = null
#### `sendCode`
##### Request ##### Request
data = uid (int)
##### Response
data = token (string)
#### `verify` 要求 `token` | 请求参数 | 请求数据 | 类型 |
##### Request | ------- | --------- | ------ |
data = code (int) | action | `ping` |`String`|
##### Response
###### Success:
code = 200
###### Verification failed:
code = 400
#### `command` 要求 `token`
##### Request
data = command (string)
##### Response ##### Response
data = message (string)
| 返回参数 | 返回数据 | 类型 |
| ------- | --------- | ------ |
| retcode | `200` |`String`|
| message | `success` |`String`|
| data | `null` |`null` |
#### `发送验证码`
##### Request
| 请求参数 | 请求数据 | 类型 |
| ------- | --------- | ------ |
| action | `sendCode`|`String`|
| data | `uid` |`Int` |
##### Response
| 返回参数 | 返回数据 | 类型 |
| ------- | --------- | ------ |
| retcode | `200` |`String`|
| message | `success` |`String`|
| data | `token` |`String`|
#### `验证验证码`
##### Request
| 请求参数 | 请求数据 | 类型 |
| ------- | --------- | ------ |
| action | `verify` |`String`|
| token | `token` |`String`|
| data | `code` |`Int` |
##### Response
成功
| 返回参数 | 返回数据 | 类型 |
| ------- | --------- | ------ |
| retcode | `200` |`String`|
| message | `success` |`String`|
| data | `null` | `null` |
失败
| 返回参数 | 返回数据 | 类型 |
| ------- | -------------------- | ------ |
| retcode | `400` |`String`|
| message | `Verification failed`|`String`|
| data | `null` |`null` |
#### `执行命令`
##### Request
| 请求参数 | 请求数据 | 类型 |
| ------- | ----------- | ------ |
| action | `command` |`String`|
| token | `token` |`String`|
| data | `command` |`String`|
##### Response
成功
| 返回参数 | 返回数据 | 类型 |
| ------- | ---------------- | ------ |
| retcode | `200` |`String`|
| message | `success` |`String`|
| data | `Command return` |`String`|

99
README_en-US.md
View File

@ -73,27 +73,84 @@ public final class JsonResponse {
} }
``` ```
## Actions ### Actions
### `ping` #### `Test connect`
data = null
### `sendCode` ##### Request
#### Request
data = uid (int)
#### Response
data = token (string)
### `verify`: Requires `token` | Request | Request data | type |
#### Request | ------- | -------------- | ------ |
data = code (int) | action | `ping` |`String`|
#### Response
##### Success:
code = 200
##### Verification failed:
code = 400
### `command`: Requires `token` ##### Response
#### Request
data = command (string) | Response | Response data | type |
#### Response | -------- | --------------- | ------ |
data = message (string) | 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`|