# NoneBot.drivers.fastapi 模块

# FastAPI 驱动适配

本驱动同时支持服务端以及客户端连接

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

# 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 即关闭

# fastapi_reload

• 类型

  Optional[bool]

• 说明

  开启/关闭冷重载，默认会在配置了 app 的 debug 模式启用

# fastapi_reload_dirs

• 类型

  Optional[List[str]]

• 说明

  重载监控文件夹列表，默认为 uvicorn 默认值

# fastapi_reload_delay

• 类型

  Optional[float]

• 说明

  重载延迟，默认为 uvicorn 默认值

# fastapi_reload_includes

• 类型

  Optional[List[str]]

• 说明

  要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值

# fastapi_reload_excludes

• 类型

  Optional[List[str]]

• 说明

  不要监听的文件列表，支持 glob pattern，默认为 uvicorn 默认值

# class Driver

基类：nonebot.drivers.ReverseDriver, nonebot.drivers.ForwardDriver

FastAPI 驱动框架

• 上报地址

  • /{adapter name}/: HTTP POST 上报

  • /{adapter name}/http/: HTTP POST 上报

  • /{adapter name}/ws: WebSocket 上报

  • /{adapter name}/ws/: WebSocket 上报

# 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)

# setup_http_polling(setup)

• 说明

  注册一个 HTTP 轮询连接，如果传入一个函数，则该函数会在每次连接时被调用

• 参数

  • setup: Union[HTTPPollingSetup, Callable[[], Awaitable[HTTPPollingSetup]]]

# setup_websocket(setup)

• 说明

  注册一个 WebSocket 连接，如果传入一个函数，则该函数会在每次重连时被调用

• 参数

  • setup: Union[WebSocketSetup, Callable[[], Awaitable[WebSocketSetup]]]

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

使用 uvicorn 启动 FastAPI

# class WebSocket

基类：nonebot.drivers.WebSocket