From 064ed817586da96d5ed06e83846363cfa123063a Mon Sep 17 00:00:00 2001 From: yanyongyu Date: Wed, 2 Dec 2020 15:14:24 +0800 Subject: [PATCH] :memo: update adapter connection guide --- docs/api/drivers/fastapi.md | 16 ++++++++++++++++ docs/guide/getting-started.md | 3 +++ nonebot/drivers/fastapi.py | 11 ++++++++++- 3 files changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/api/drivers/fastapi.md b/docs/api/drivers/fastapi.md index 1f7f96ee..b4f5c6fb 100644 --- a/docs/api/drivers/fastapi.md +++ b/docs/api/drivers/fastapi.md @@ -17,6 +17,22 @@ sidebarDepth: 0 FastAPI 驱动框架 +* **上报地址** + + + * `/{adapter name}/`: HTTP POST 上报 + + + * `/{adapter name}/http/`: HTTP POST 上报 + + + * `/{adapter name}/ws`: WebSocket 上报 + + + * `/{adapter name}/ws/`: WebSocket 上报 + + + ### _property_ `type` 驱动名称: `fastapi` diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index b1708b22..8ed182eb 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -16,8 +16,11 @@ nb create ```python{3,4,7} import nonebot +from nonebot.adapters.cqhttp import Bot as CQHTTPBot nonebot.init() +driver = nonebot.get_driver() +driver.register_adapter("cqhttp", CQHTTPBot) nonebot.load_builtin_plugins() if __name__ == "__main__": diff --git a/nonebot/drivers/fastapi.py b/nonebot/drivers/fastapi.py index 973cf052..841b82e5 100644 --- a/nonebot/drivers/fastapi.py +++ b/nonebot/drivers/fastapi.py @@ -39,7 +39,16 @@ def get_auth_bearer(access_token: Optional[str] = Header( class Driver(BaseDriver): - """FastAPI 驱动框架""" + """ + FastAPI 驱动框架 + + :上报地址: + + * ``/{adapter name}/``: HTTP POST 上报 + * ``/{adapter name}/http/``: HTTP POST 上报 + * ``/{adapter name}/ws``: WebSocket 上报 + * ``/{adapter name}/ws/``: WebSocket 上报 + """ def __init__(self, env: Env, config: Config): super().__init__(env, config)