nonebot2/docs/api/drivers/fastapi.md

contentSidebar	sidebarDepth
true	0

NoneBot.drivers.fastapi 模块

FastAPI 驱动适配

后端使用方法请参考: FastAPI 文档

class Driver

基类：nonebot.drivers.Driver

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

on_shutdown(func)

参考文档: Events

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

使用 uvicorn 启动 FastAPI

async _handle_http(adapter, request, data=Body(Ellipsis))

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

async _handle_ws_reverse(adapter, websocket)

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

class WebSocket

基类：nonebot.drivers.WebSocket

property closed

• 类型

  bool

• 说明

  连接是否已经关闭

async accept()

接受 WebSocket 连接请求

async close(code=1000)

关闭 WebSocket 连接请求

async receive()

接收一条 WebSocket 信息

async send(data)

发送一条 WebSocket 信息