mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-07-27 00:01:27 +00:00
📝 update doc
This commit is contained in:
@ -9,6 +9,23 @@ sidebarDepth: 0
|
||||
|
||||
协议详情请看: [CQHTTP](https://github.com/howmanybots/onebot/blob/master/README.md) | [OneBot](https://github.com/howmanybots/onebot/blob/master/README.md)
|
||||
|
||||
# NoneBot.adapters.cqhttp.config 模块
|
||||
|
||||
|
||||
## _class_ `Config`
|
||||
|
||||
CQHTTP 配置类
|
||||
|
||||
|
||||
* **配置项**
|
||||
|
||||
|
||||
* `access_token` / `cqhttp_access_token`: CQHTTP 协议授权令牌
|
||||
|
||||
|
||||
* `secret` / `cqhttp_secret`: CQHTTP HTTP 上报数据签名口令
|
||||
|
||||
|
||||
# NoneBot.adapters.cqhttp.utils 模块
|
||||
|
||||
|
||||
|
@ -9,6 +9,23 @@ sidebarDepth: 0
|
||||
|
||||
协议详情请看: [钉钉文档](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p)
|
||||
|
||||
# NoneBot.adapters.ding.config 模块
|
||||
|
||||
|
||||
## _class_ `Config`
|
||||
|
||||
钉钉配置类
|
||||
|
||||
|
||||
* **配置项**
|
||||
|
||||
|
||||
* `access_token` / `ding_access_token`: 钉钉令牌
|
||||
|
||||
|
||||
* `secret` / `ding_secret`: 钉钉 HTTP 上报数据签名口令
|
||||
|
||||
|
||||
# NoneBot.adapters.ding.exception 模块
|
||||
|
||||
|
||||
|
@ -21,6 +21,26 @@ Mirai-API-HTTP 的适配器以 [AGPLv3许可](https://opensource.org/licenses/AG
|
||||
这意味着在使用该适配器时需要 **以该许可开源您的完整程序代码**
|
||||
:::
|
||||
|
||||
# NoneBot.adapters.mirai.config 模块
|
||||
|
||||
|
||||
## _class_ `Config`
|
||||
|
||||
Mirai 配置类
|
||||
|
||||
|
||||
* **必填**
|
||||
|
||||
|
||||
* `auth_key` / `mirai_auth_key`: mirai-api-http 的 auth_key
|
||||
|
||||
|
||||
* `mirai_host`: mirai-api-http 的地址
|
||||
|
||||
|
||||
* `mirai_port`: mirai-api-http 的端口
|
||||
|
||||
|
||||
# NoneBot.adapters.mirai.bot 模块
|
||||
|
||||
|
||||
@ -690,28 +710,6 @@ mirai-api-http 正向 Websocket 协议 Bot 适配。
|
||||
* `qq: int`: 要使用的Bot的QQ号 **注意: 在使用正向Websocket时必须指定该值!**
|
||||
|
||||
|
||||
# NoneBot.adapters.mirai.config 模块
|
||||
|
||||
|
||||
## _class_ `Config`
|
||||
|
||||
基类:`pydantic.main.BaseModel`
|
||||
|
||||
Mirai 配置类
|
||||
|
||||
|
||||
* **必填**
|
||||
|
||||
|
||||
* `mirai_auth_key`: mirai-api-http的auth_key
|
||||
|
||||
|
||||
* `mirai_host`: mirai-api-http的地址
|
||||
|
||||
|
||||
* `mirai_port`: mirai-api-http的端口
|
||||
|
||||
|
||||
# NoneBot.adapters.mirai.message 模块
|
||||
|
||||
|
||||
|
@ -10,6 +10,58 @@ sidebarDepth: 0
|
||||
后端使用方法请参考: [FastAPI 文档](https://fastapi.tiangolo.com/)
|
||||
|
||||
|
||||
## _class_ `Config`
|
||||
|
||||
基类:`pydantic.env_settings.BaseSettings`
|
||||
|
||||
FastAPI 驱动框架设置,详情参考 FastAPI 文档
|
||||
|
||||
|
||||
### `fastapi_openapi_url`
|
||||
|
||||
|
||||
* **类型**
|
||||
|
||||
`Optional[str]`
|
||||
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
openapi.json 地址,默认为 None 即关闭
|
||||
|
||||
|
||||
|
||||
### `fastapi_docs_url`
|
||||
|
||||
|
||||
* **类型**
|
||||
|
||||
`Optional[str]`
|
||||
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
swagger 地址,默认为 None 即关闭
|
||||
|
||||
|
||||
|
||||
### `fastapi_redoc_url`
|
||||
|
||||
|
||||
* **类型**
|
||||
|
||||
`Optional[str]`
|
||||
|
||||
|
||||
|
||||
* **说明**
|
||||
|
||||
redoc 地址,默认为 None 即关闭
|
||||
|
||||
|
||||
|
||||
## _class_ `Driver`
|
||||
|
||||
基类:[`nonebot.drivers.Driver`](README.md#nonebot.drivers.Driver)
|
||||
|
Reference in New Issue
Block a user