# MVCAPI **Repository Path**: Ray_Hughes/mvcapi ## Basic Information - **Project Name**: MVCAPI - **Description**: 这是API文档的离线版本不定时更新 - **Primary Language**: Java - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2023-04-17 - **Last Updated**: 2023-04-17 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # SunMoonMVC **简介**: SunMoonMVC **HOST**:http://localhost:8088 **联系人**: 1523165110 **Version**:v1.0.0 **接口路径**:/v3/api-docs/default [TOC] # 请求码示例 ```java @Getter @AllArgsConstructor @ToString public enum ResultCode { SUCCESS(0, "请求成功"), FAIL(-1, "请求失败"), PARAM_ERROR(400, "参数错误"), UNAUTHORIZED(401, "未授权"), FORBIDDEN(403, "禁止访问"), NOT_FOUND(404, "资源不存在"), INTERNAL_SERVER_ERROR(500, "服务器内部错误"), CONFLICT(409, "资源冲突"), UNREGISTERED(410, "资源未注册"), IP_ERROR(411, "IP错误"), DATA_ERROR(412, "数据错误"), OVER_TIME(413, "资源过期"), FULL(507, "资源已满"); private final int code; private final String message; } ``` # 插件管理请求 --- ## 通过插件名获取插件数据 **接口地址**:`/plugin/{name}` **请求方式**:`GET` **请求数据类型**:`application/x-www-form-urlencoded` **响应数据类型**:`*/*` **接口描述**: **请求参数**: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | -------- | -------- | ----- | -------- | -------- | ------ | |name|插件名|path|true|string|| |Authorization|授权码|header|true|string|| **响应状态**: | 状态码 | 说明 | schema | | -------- | -------- | ----- | |200|OK|Result| **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | -------- | -------- | ----- |----- | |data||object|| |code||integer(int32)|integer(int32)| |msg||string|| **响应示例**: `http://localhost:8088/plugin/Gens` ```json { "data": { "id": 1, "name": "GenshinMap", "display": "原X地图" }, "code": 0, "msg": "请求成功" } ``` --- ## 获取插件列表 **接口地址**:`/plugin/list` **请求方式**:`GET` **请求数据类型**:`application/x-www-form-urlencoded` **响应数据类型**:`*/*` **接口描述**: **请求参数**: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | -------- | -------- | ----- | -------- | -------- | ------ | |Authorization|授权码|header|true|string|| **响应状态**: | 状态码 | 说明 | schema | | -------- | -------- | ----- | |200|OK|Result| **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | -------- | -------- | ----- |----- | |data||object|| |code||integer(int32)|integer(int32)| |msg||string|| **响应示例**: ```json { "data": [ { "id": 1, "name": "GenshinMap", "display": "原X地图" }, { "id": 2, "name": "ExamplePlugin", "display": "测试插件" } ], "code": 0, "msg": "请求成功" } ``` --- # 验证码管理 --- ## 校验是否可以运行 **接口地址**:`/user/check` **请求方式**:`POST` **请求数据类型**:`application/x-www-form-urlencoded,application/json` **响应数据类型**:`*/*` **接口描述**: **请求示例**: ```json { "code":"b4c7e127-577e-4a2e-975c-4d5ec2f7d4d2", "port":"25565", "ip":"top.maplex.test", "data":"ExamplePlugin" } ``` **请求参数**: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | -------- | -------- | ----- | -------- | -------- | ------ | |Authorization|授权码|header|true|string|| |jSONObject|JSONObject|body|true|JSONObject|JSONObject| |  empty|||false|boolean|| |code|验证码|query|false||| |port|端口|query|false||| |ip|IP|query|false||| |data|插件名|query|false||| **响应状态**: | 状态码 | 说明 | schema | | -------- | -------- | ----- | |200|OK|Result| **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | -------- | -------- | ----- |----- | |data||object|| |code||integer(int32)|integer(int32)| |msg||string|| **响应示例**: ```json { "data": { "id": 11, "code": "b4c7e127-577e-4a2e-975c-4d5ec2f7d4d2", "port": 25565 }, "code": 0, "msg": "请求成功" } ``` --- # 用户管理 --- ## 删除code **接口地址**:`/info/{code}` **请求方式**:`DELETE` **请求数据类型**:`application/x-www-form-urlencoded` **响应数据类型**:`*/*` **接口描述**: **请求参数**: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | -------- | -------- | ----- | -------- | -------- | ------ | |Authorization|授权码|header|true|string|| |code|激活码|query|true|string|| **响应状态**: | 状态码 | 说明 | schema | | -------- | -------- | ----- | |200|OK|Result| **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | -------- | -------- | ----- |----- | |data||object|| |code||integer(int32)|integer(int32)| |msg||string|| **响应示例**: ```json { "code": 0, "msg": "请求成功" } ``` --- ## 通过QQ获取所有验证码数据 **接口地址**:`/info/{qqcode}` **请求方式**:`GET` **请求数据类型**:`application/x-www-form-urlencoded` **响应数据类型**:`*/*` **接口描述**: **请求参数**: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | -------- | -------- | ----- | -------- | -------- | ------ | |Authorization|授权码|header|true|string|| |qqcode|QQ号|query|true|string|| **响应状态**: | 状态码 | 说明 | schema | | -------- | -------- | ----- | |200|OK|Result| **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | -------- | -------- | ----- |----- | |data||object|| |code||integer(int32)|integer(int32)| |msg||string|| **响应示例**: ```json { "data": [ { "id": 9, "code": "280d09bf-f5c9-4fae-add2-f489f1b102fa", "ip": "0.0.0.0", "qqcode": "1523165110", "remark": "枫溪2", "max": 3, "data": 2, "overTime": "2023-05-01T04:00:01.000+00:00" }, { "id": 8, "code": "edbfae1f-756f-45ab-acd0-2113177c2e50", "ip": "0.0.0.0", "qqcode": "1523165110", "remark": "枫溪2", "max": 3, "data": 2, "overTime": "2023-05-01T04:00:01.000+00:00" }, { "id": 7, "code": "b4c7e127-577e-4a2e-975c-4d5ec2f7d4d2", "ip": "0.0.0.0", "qqcode": "1523165110", "remark": "枫溪2", "max": 3, "data": 2, "overTime": "2023-05-01T04:00:01.000+00:00" }, { "id": 6, "code": "fdf4a367-2fbc-4b5a-a04d-56b2956d04d2", "ip": "127.0.0.1", "qqcode": "1523165110", "remark": "枫溪2", "max": 3, "data": 2 } ], "code": 0, "msg": "请求成功" } ``` --- ## 注册一个新的用户 **接口地址**:`/info/add` **请求方式**:`PUT` **请求数据类型**:`application/x-www-form-urlencoded,application/json` **响应数据类型**:`*/*` **接口描述**: **请求示例**: ```json { "qqcode":"1523165110", "remark":"枫溪2", "time":"2023-5-1 12:00:01", "data": "2" } ``` **请求参数**: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | -------- | -------- | ----- | -------- | -------- | ------ | |Authorization|授权码|header|true|string|| |jSONObject|JSONObject|body|true|JSONObject|JSONObject| |  empty|||false|boolean|| |qqcode|QQ号|query|false||| |remark|备注(通常为qq名)|query|false||| |data|插件名/插件编号|query|false||| |time|到期日期|query|false||| **响应状态**: | 状态码 | 说明 | schema | | -------- | -------- | ----- | |200|OK|Result| **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | -------- | -------- | ----- |----- | |data||object|| |code||integer(int32)|integer(int32)| |msg||string|| **响应示例**: ```json { "data": { "id": 9, "code": "280d09bf-f5c9-4fae-add2-f489f1b102fa", "ip": "0.0.0.0", "qqcode": "1523165110", "remark": "枫溪2", "max": 3, "data": 2, "overTime": "2023-05-01T04:00:01.000+00:00" }, "code": 0, "msg": "请求成功" } ``` --- ## 重置IP绑定 **接口地址**:`/info/rest` **请求方式**:`POST` **请求数据类型**:`application/x-www-form-urlencoded,application/json` **响应数据类型**:`*/*` **接口描述**: **请求示例**: ```json { "code": "fdf4a367-2fbc-4b5a-a04d-56b2956d04d2" } ``` **请求参数**: | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | -------- | -------- | ----- | -------- | -------- | ------ | |Authorization|授权码|header|true|string|| |jSONObject|JSONObject|body|true|JSONObject|JSONObject| |  empty|||false|boolean|| |code|激活码|query|false||| **响应状态**: | 状态码 | 说明 | schema | | -------- | -------- | ----- | |200|OK|Result| **响应参数**: | 参数名称 | 参数说明 | 类型 | schema | | -------- | -------- | ----- |----- | |data||object|| |code||integer(int32)|integer(int32)| |msg||string|| **响应示例**: ```json { "data": { "id": 6, "code": "fdf4a367-2fbc-4b5a-a04d-56b2956d04d2", "ip": "0.0.0.0", "qqcode": "1523165110", "remark": "枫溪2", "max": 3, "data": 2 }, "code": 0, "msg": "请求成功" } ```