diff --git a/README.md b/README.md index 63537ac..3599114 100644 --- a/README.md +++ b/README.md @@ -88,26 +88,84 @@ public final class JsonResponse { ``` ### Actions 动作 -#### `ping` -data = null +#### `测试连接` -#### `sendCode` ##### Request -data = uid (int) -##### Response -data = token (string) -#### `verify` 要求 `token` -##### Request -data = code (int) -##### Response -###### Success: -code = 200 -###### Verification failed: -code = 400 +| 请求参数 | 请求数据 | 类型 | +| ------- | --------- | ------ | +| action | `ping` |`String`| -#### `command` 要求 `token` -##### Request -data = command (string) ##### 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`| \ No newline at end of file diff --git a/README_en-US.md b/README_en-US.md index 9722184..a1369db 100644 --- a/README_en-US.md +++ b/README_en-US.md @@ -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`| \ No newline at end of file