diff --git a/nonebot/drivers/fastapi.py b/nonebot/drivers/fastapi.py index 59f82563..882e97b0 100644 --- a/nonebot/drivers/fastapi.py +++ b/nonebot/drivers/fastapi.py @@ -76,6 +76,16 @@ class Config(BaseSettings): ``redoc`` 地址,默认为 ``None`` 即关闭 """ + fastapi_include_adapter_schema: bool = True + """ + :类型: + + ``bool`` + + :说明: + + 是否包含适配器路由的 schema,默认为 ``True`` + """ fastapi_reload: bool = False """ :类型: @@ -179,6 +189,7 @@ class Driver(ReverseDriver): _handle, name=setup.name, methods=[setup.method], + include_in_schema=self.fastapi_config.fastapi_include_adapter_schema, ) @overrides(ReverseDriver) diff --git a/website/docs/tutorial/choose-driver.md b/website/docs/tutorial/choose-driver.md index b157b128..454f994f 100644 --- a/website/docs/tutorial/choose-driver.md +++ b/website/docs/tutorial/choose-driver.md @@ -82,6 +82,12 @@ DRIVER=~fastapi 默认值: `None` 说明: `FastAPI` 提供的 `ReDoc` 文档地址,如果为 `None`,则不提供 `ReDoc` 文档。 +##### `fastapi_include_adapter_schema` + +类型: `bool` +默认值: `True` +说明: `FastAPI` 提供的 `OpenAPI` JSON 定义中是否包含适配器路由的 `Schema`。 + ##### `fastapi_reload` 类型: `bool`