Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
G
go-cqhttp
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
nanahira
go-cqhttp
Commits
51101f02
Commit
51101f02
authored
Oct 04, 2020
by
Mrs4s
Committed by
GitHub
Oct 04, 2020
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #344 from scjtqs/adminApiDev
修复 获取 当前配置的方法名错误问题,增加当前admin api的 doc
parents
d4811d53
4d404eac
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
233 additions
and
1 deletion
+233
-1
docs/adminApi.md
docs/adminApi.md
+232
-0
server/apiAdmin.go
server/apiAdmin.go
+1
-1
No files found.
docs/adminApi.md
0 → 100644
View file @
51101f02
# 管理 API
> 支持跨域
## 公共参数
参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- |
| access_token | string | 校验口令,config.json中配置 |
## admin/do_restart
### 热重启
> 热重启
> ps: 目前不支持ws部分的修改生效
method:
`POST/GET`
参数:
| 参数名 | 类型 | 说明 |
| ------ | ---- | ------------------------------------- |
| 无|||
返回:
```
json
{
"data"
:
{},
"retcode"
:
0
,
"status"
:
"ok"
}
```
### admin/get_web_write
> 拉取验证码/设备锁
method:
`GET`
参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- |
| 无|||
返回:
```
json
{
"data"
:
{
"ispic"
:
true
,
"picbase64"
:
"xxxxx"
},
"retcode"
:
0
,
"status"
:
"ok"
}
```
| 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- |
| ispic| bool| 是否是验证码类型 true是,false为不是(比如设备锁|
|picbas64| string| 验证码的base64编码内容,加上头,放入img标签即可显示|
### admin/do_web_write
> web输入验证码/设备锁确认
method:
`POST`
formdata
参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ----------- |
| input | string | 输入的类容 |
返回:
```
json
{
"data"
:
{},
"retcode"
:
0
,
"status"
:
"ok"
}
```
### admin/do_restart_docker
> 冷重启
> 注意:此api 会直接结束掉进程,需要依赖docker/supervisor等进程管理工具来自动拉起
method:
`POST`
参数:
| 参数名 |类型 | 说明 |
| ------ | ------ | -----------|
| 无 | | |
返回:
```
json
{
"data"
:
{},
"retcode"
:
0
,
"status"
:
"ok"
}
```
### admin/do_config_base
> 基础配置
method:
`POST`
formdata
参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ |
| uin | string | qq号 |
| password | string | qq密码 |
| enable_db | string | 是否启动数据库,填 'true' 或者 'false' |
| access_token | string | 授权 token |
返回:
```
json
{
"data"
:
{},
"retcode"
:
0
,
"status"
:
"ok"
}
```
### admin/do_config_http
> http服务配置
method:
`POST`
formdata
参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ |
| port | string | 服务端口 |
| host | string | 服务监听地址 |
| enable | string | 是否启用 ,填 'true' 或者 'false' |
| timeout | string | http请求超时时间 |
| post_url | string | post上报地址 不需要就填空字符串,或者不填|
| post_secret | string | post上报的secret 不需要就填空字符串,或者不填 |
返回:
```
json
{
"data"
:
{},
"retcode"
:
0
,
"status"
:
"ok"
}
```
### admin/do_config_ws
> 正向ws设置
method:
`POST`
formdata
参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ |
| port | string | 服务端口 |
| host | string | 服务监听地址 |
| enable | string | 是否启用 ,填 'true' 或者 'false' |
返回:
```
json
{
"data"
:
{},
"retcode"
:
0
,
"status"
:
"ok"
}
```
### admin/do_config_reverse
> 反向ws配置
method:
`POST`
formdata
参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ |
| port | string | 服务端口 |
| host | string | 服务监听地址 |
| enable | string | 是否启用 ,填 'true' 或者 'false' |
返回:
```
json
{
"data"
:
{},
"retcode"
:
0
,
"status"
:
"ok"
}
```
### admin/do_config_json
> 直接修改 config.json配置
method:
`POST`
formdata
参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ |
| json | string | 完整的config.json的配合,json字符串 |
返回:
```
json
{
"data"
:
{},
"retcode"
:
0
,
"status"
:
"ok"
}
```
### admin/get_config_json
> 获取当前 config.json配置
method:
`GET`
参数:
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ |
| 无 | | |
返回:
```
json
{
"data"
:
{
"config"
:
"xxxx"
},
"retcode"
:
0
,
"status"
:
"ok"
}
```
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------------------------------------------ |
| config | string | 完整的config.json的配合,json字符串 |
server/apiAdmin.go
View file @
51101f02
...
@@ -50,7 +50,7 @@ var HttpuriAdmin = map[string]func(s *webServer, c *gin.Context){
...
@@ -50,7 +50,7 @@ var HttpuriAdmin = map[string]func(s *webServer, c *gin.Context){
"do_config_ws"
:
AdminDoConfigWs
,
//修改config.json的正向ws部分
"do_config_ws"
:
AdminDoConfigWs
,
//修改config.json的正向ws部分
"do_config_reverse"
:
AdminDoConfigReverse
,
//修改config.json 中的反向ws部分
"do_config_reverse"
:
AdminDoConfigReverse
,
//修改config.json 中的反向ws部分
"do_config_json"
:
AdminDoConfigJson
,
//直接修改 config.json配置
"do_config_json"
:
AdminDoConfigJson
,
//直接修改 config.json配置
"get_config_json"
:
Admin
DoConfigJson
,
//拉取 当前的config.json配置
"get_config_json"
:
Admin
GetConfigJson
,
//拉取 当前的config.json配置
}
}
func
Failed
(
code
int
,
msg
string
)
coolq
.
MSG
{
func
Failed
(
code
int
,
msg
string
)
coolq
.
MSG
{
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment