# :-: CoolQ HTTP API组件文档
>[danger] 当前文档为 `1.x` 版本的文档。simple-robot 1.x 版本已经被认定为过时且停止维护,请前往 `2.x` 版本文档:https://www.yuque.com/simpler-robot/simpler-robot-doc
:-: **\[CQ HTTP FOR JAVA\]**
:-: [![](https://img.shields.io/badge/simple--robot-core-green)](https://github.com/ForteScarlet/simple-robot-core) [![](https://img.shields.io/maven-central/v/io.github.ForteScarlet.simple-robot-core/component-forcoolqhttpapi)](https://search.maven.org/artifact/io.github.ForteScarlet.simple-robot-core/component-forcoolqhttpapi)
**CQ HTTP API组件是一个基于**[**酷Q平台**](https://cqp.cc/)**、**[**CQ HTTP API插件**](https://github.com/richardchien/coolq-http-api)**、**[**simple-robot核心库**](https://github.com/ForteScarlet/simple-robot-core)**的JavaQQ机器人开发框架。**
*****
**文档首页**:[前言](./前言.md)
**如何阅读**:[我该如何阅读文档](./我该如何阅读文档.md)
**视频教程**:[视频教程](./视频教程.md)
**通用配置**:[通用配置](./配置文件.md)
**通用功能与API**:[通用功能与API](./支持组件-通用内容.md)
*****
**CQ HTTP API组件 快速开始**:[CQ HTTP API-组件-快速开始](./组件-酷Q-CoolQHTTPAPI/快速开始核心1.8.x以上.md)
**CQ HTTP API组件 springboot-starter**:[CQ HTTP API-组件-快速开始](./组件-酷Q-CoolQHTTPAPI/Springboot快速启动器.md)
*****
>[danger] 酷Q已亡,音容宛在。
> "愿我们能在更开放的平行世界里相遇" —— cq@hex.app
>[success] 基于酷Q平台,所以需要依赖于酷Q。
>[success] 基于酷Q平台的CQ HTTP API插件,此组件使用其HTTP协议并依赖于此插件,提供此插件提供的所有API。
>[success] 基于simple-robot核心库,提供核心库提供的一切功能与特性。
>[success] 有视频教程 [av96117517](https://www.bilibili.com/video/av96117517)、[bv1ik4y197CL](https://www.bilibili.com/video/bv1ik4y197CL)
- 前言
- 简单介绍
- 我该如何阅读文档
- 视频教程
- 安装与使用
- 开源协议
- 免责&捐助
- 注意事项
- 版本命名规则简介
- 主要功能版本历史
- 功能指引
- 通用API与功能
- 国际化语言
- 异常
- 消息监听
- @Listen
- @OnListen模板
- @Filter
- 消息参数截取
- @Spare
- @Constr
- @Ignore
- @ListenBreak
- @ListenBreakPlugin
- @ListenBody
- 监听响应
- 成功判定与返回值
- 监听上下文
- 动态参数
- 监听消息API
- 异步监听 @Async
- 限流监听 @Limit
- 自定义Http送信器
- 枚举与类型
- 送信器
- SENDER
- SETTER
- GETTER
- 返回值
- 其他位置
- 日志与日志拦截
- 异常处理
- 依赖注入
- 自定义依赖获取
- 批量依赖载入
- 注意事项
- 常量
- 定时任务
- 自定义过滤
- 拦截器
- 拦截器总定义
- 上下文对象总定义
- 监听消息拦截
- 送信器拦截
- 监听函数拦截
- CAT码
- CQ码
- CQCode
- CQ码工具类
- CQ扩展工具类
- AppendList拼接链
- 高级内容
- 阻断机制
- 截断机制
- 自定义枚举类型
- 枚举工厂
- byName注解
- 自定义注解
- 配置
- 文件配置
- 注解配置
- 参数配置
- 多配置
- 多账号
- 自定义账号管理器
- 小心!
- 核心版本与组件如何升级核心
- 核心版本迭代指南
- 核心
- 更新日志
- jar包与依赖
- 监听消息类结构图
- 快速启动
- 模组与扩展
- 模组开发
- 现有模组
- 通用模组-延时任务
- 通用模组-CQ码工具
- 转义器
- CQ码操作工具类
- CQ码模板-CodeTemplate
- CQ码载体-KQCode
- CQ码构建器
- MQ码工具类
- 通用模组-redis-bot管理器
- 通用模组-Debugger
- Debugger-common模块
- Debugger-server模块
- Debugger-client模块
- 通用模组-钉钉机器人
- 组件-Mirai(JVM)
- 快速开始(1.13+)
- springboot-starter
- 注意事项
- 配置
- 额外的内容
- 快速回复
- 额外监听
- CQ码解析
- 组件-酷Q(QQ)-CQ HTTP API(基本失效)
- 快速开始(推荐)
- 快速开始(1.7.x以下,不推荐)
- 快速开始(Springboot启动器)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 额外的内容
- 自定义额外监听
- CQ送信器
- 元事件
- 监听消息类结构图
- 组件-酷Q(QQ)-JCQ(失效)
- 快速开始
- 更新日志
- 额外的内容
- JCQ日志
- 配置
- 注意事项
- 监听消息类结构图
- 组件-酷Q(QQ)-HTTP TO CQ(失效)
- 快速开始(核心1.7.x及以下)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 监听消息类结构图
- 组件-酷Q(QQ)-LEMOC (失效)
- 快速开始(核心1.7.x及以下)
- 配置
- 注意事项
- 更新日志
- 监听消息类结构图
- Springboot快速启动器
- 常见问题汇总
- BUG反馈
- 更新计划总览