CoolQ HTTP API 插件配置详解

最新推荐文章于 2025-06-27 09:14:11 发布

原创最新推荐文章于 2025-06-27 09:14:11 发布 · 266 阅读

4 ·

CC 4.0 BY-SA版权

CoolQ HTTP API 插件配置详解

配置文件概述

CoolQ HTTP API 插件提供了灵活的配置方式，支持 INI 和 JSON 两种格式。配置文件可以集中管理多个账号的配置，也可以为每个账号单独配置。理解这些配置方式对于高效使用该插件至关重要。

配置文件加载机制

插件启动时会按照以下顺序尝试加载配置文件：

优先尝试加载 config.cfg 或 config.ini 文件
如果不存在，则尝试加载 config\general.(cfg|ini) 和 config\<user_id>.(cfg|ini) 组合
如果上述都不存在，尝试加载 config.json 文件
最后尝试加载 config\general.json 和 config\<user_id>.json 组合

重要提示：如果配置文件中需要使用中文或其他非ASCII字符，必须使用UTF-8 without BOM编码保存文件。

配置格式示例

INI格式多账号配置示例

[general]
host = 0.0.0.0
post_url = http://192.168.0.11:8888

[12345678]
access_token = Mgep4rV49rM8Jf
port = 5700

[87654321]
port = 5701

JSON格式多账号配置示例

{
    "general": {
        "host": "0.0.0.0",
        "post_url": "http://127.0.0.1:8080"
    },
    "12345678": {
        "access_token": "Mgep4rV49rM8Jf",
        "port": 5700
    },
    "87654321": {
        "port": 5701
    }
}

JSON格式单账号配置示例

通用配置文件 config\general.json：

{
    "host": "0.0.0.0",
    "post_url": "http://127.0.0.1:8080"
}

特定账号配置文件 config\12345678.json：

{
    "access_token": "Mgep4rV49rM8Jf",
    "port": 5700
}

核心配置项详解

网络通信配置

HTTP服务器配置：
- host：监听IP，默认为[::]（IPv6所有地址）
- port：监听端口，默认为5700
- use_http：是否启用HTTP接口，默认为true
WebSocket配置：
- ws_host/ws_port：WebSocket服务器监听设置
- use_ws：是否启用WebSocket服务器，默认为false
反向WebSocket配置：
- ws_reverse_url：反向WebSocket地址
- use_ws_reverse：是否启用反向WebSocket，默认为false

安全配置

access_token：API访问令牌，用于验证请求合法性
secret：上报数据签名密钥，用于验证数据完整性

消息处理配置

post_message_format：消息格式，可选string(字符串)或array(数组)
convert_unicode_emoji：是否转换Unicode表情符号，默认为true

性能优化配置

thread_pool_size：工作线程池大小
server_thread_pool_size：API服务器线程池大小
enable_rate_limited_actions：是否启用API调用限速
rate_limit_interval：限速间隔时间(毫秒)

日志配置

show_log_console：是否显示日志控制台
log_level：日志级别(debug/info/warning/error/fatal)
max_log_file_size：单日志文件最大大小(字节)
max_log_files：最大日志文件备份数量

典型配置方案

开发环境配置

{
    "log_level": "debug",
    "show_log_console": true,
    "disable_coolq_log": false
}

生产环境推荐配置

{
    "use_http": false,
    "use_ws": true,
    "access_token": "your-secure-token",
    "secret": "your-secret-key",
    "thread_pool_size": 8,
    "server_thread_pool_size": 12,
    "event_filter": "filter.json",
    "show_log_console": false,
    "max_log_files": 5,
    "log_level": "info",
    "enable_heartbeat": true,
    "enable_rate_limited_actions": true
}