nonebot2/website/versioned_docs/version-2.4.1/api/drivers/fastapi.md

mdx	sidebar_position	description
format md	1	nonebot.drivers.fastapi 模块

nonebot.drivers.fastapi

FastAPI 驱动适配

nb driver install fastapi
# 或者
pip install nonebot2[fastapi]

:::tip 提示 本驱动仅支持服务端连接 :::

class Config(<auto>)

• 说明: FastAPI 驱动框架设置，详情参考 FastAPI 文档

• 参数

  auto

class-var fastapi_openapi_url

• 类型: str | None

• 说明: openapi.json 地址，默认为 None 即关闭

class-var fastapi_docs_url

• 类型: str | None

• 说明: swagger 地址，默认为 None 即关闭

class-var fastapi_redoc_url

• 类型: str | None

• 说明: redoc 地址，默认为 None 即关闭

class-var fastapi_include_adapter_schema

• 类型: bool

• 说明: 是否包含适配器路由的 schema，默认为 True

class-var fastapi_reload

• 类型: bool

• 说明: 开启/关闭冷重载

class-var fastapi_reload_dirs

• 类型: list[str] | None

• 说明: 重载监控文件夹列表，默认为 uvicorn 默认值

class-var fastapi_reload_delay

• 类型: float

• 说明: 重载延迟，默认为 uvicorn 默认值

class-var fastapi_reload_includes

• 类型: list[str] | None

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

class-var fastapi_reload_excludes

• 类型: list[str] | None

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

class-var fastapi_extra

• 类型: dict[str, Any]

• 说明: 传递给 FastAPI 的其他参数。

class Driver(env, config)

• 说明: FastAPI 驱动框架。

• 参数

  • env (Env)

  • config (NoneBotConfig)

property type

• 类型: str

• 说明: 驱动名称: fastapi

property server_app

• 类型: FastAPI

• 说明: FastAPI APP 对象

property asgi

• 类型: FastAPI

• 说明: FastAPI APP 对象

property logger

• 类型: logging.Logger

• 说明: fastapi 使用的 logger

method setup_http_server(setup)

• 参数

  • setup (HTTPServerSetup)

• 返回

  • untyped

method setup_websocket_server(setup)

• 参数

  • setup (WebSocketServerSetup)

• 返回

  • None

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

• 说明: 使用 uvicorn 启动 FastAPI

• 参数

  • host (str | None)

  • port (int | None)

  • *args

  • app (str | None)

  • **kwargs

• 返回

  • untyped

class FastAPIWebSocket(*, request, websocket)

• 说明: FastAPI WebSocket Wrapper

• 参数

  • request (BaseRequest)

  • websocket (WebSocket)

async method accept()

• 参数

  empty

• 返回

  • None

async method close(code=status.WS_1000_NORMAL_CLOSURE, reason="")

• 参数

  • code (int)

  • reason (str)

• 返回

  • None

async method receive()

• 参数

  empty

• 返回

  • str | bytes

async method receive_text()

• 参数

  empty

• 返回

  • str

async method receive_bytes()

• 参数

  empty

• 返回

  • bytes

async method send_text(data)

• 参数

  • data (str)

• 返回

  • None

async method send_bytes(data)

• 参数

  • data (bytes)

• 返回

  • None