# NoneBot.drivers.fastapi 模块

# FastAPI 驱动适配

后端使用方法请参考: FastAPI 文档 (opens new window)

# class Driver

基类:nonebot.drivers.BaseDriver

FastAPI 驱动框架

# __init__(env, config)

  • 参数

  • env: Env: 包含环境信息的 Env 对象

  • config: Config: 包含配置信息的 Config 对象

# property type

驱动名称: fastapi

# property server_app

FastAPI APP 对象

# property asgi

FastAPI APP 对象

# property logger

fastapi 使用的 logger

# on_startup(func)

参考文档: Events (opens new window)

# on_shutdown(func)

参考文档: Events (opens new window)

# run(host=None, port=None, *, app=None, **kwargs)

使用 uvicorn 启动 FastAPI

# async _handle_http(adapter, data=Body(Ellipsis), x_self_id=Header(None), x_signature=Header(None), auth=Depends(get_auth_bearer))

用于处理 HTTP 类型请求的函数

# async _handle_ws_reverse(adapter, websocket, x_self_id=Header(None), auth=Depends(get_auth_bearer))

用于处理 WebSocket 类型请求的函数

# class WebSocket

基类:nonebot.drivers.BaseWebSocket

# __init__(websocket)

  • 参数

  • websocket: Any: WebSocket 连接对象

# property closed

  • 类型

    bool

  • 说明

    连接是否已经关闭

# async accept()

接受 WebSocket 连接请求

# async close(code=1000)

关闭 WebSocket 连接请求

# async receive()

接收一条 WebSocket 信息

# async send(data)

发送一条 WebSocket 信息