FastAPI系列:FastAPI类参数说明
FastAPI类参数说明
def __init__(
self,
*,
debug: bool = False, # 是否启动调试模式
routes: Optional[List[BaseRoute]] = None, #自定义路由列表
title: str = "FastAPI", # api文档的标题
description: str = "", # api文档的描述
version: str = "0.1.0", # api版本号
openapi_url: Optional[str] = "/openapi.json", # OpenAPI 规范的 URL
openapi_tags: Optional[List[Dict[str, Any]]] = None, # # OpenAPI文档中的标签
servers: Optional[List[Dict[str, Union[str, Any]]]] = None, # api的服务器列表
dependencies: Optional[Sequence[Depends]] = None, # 依赖项列表
default_response_class: Type[Response] = Default(JSONResponse), # 默认的响应类
docs_url: Optional[str] = "/docs", # 自动生成的api文档的url
redoc_url: Optional[str] = "/redoc", # 自动生成的 ReDoc 文档的 URL
swagger_ui_oauth2_redirect_url: Optional[str] = "/docs/oauth2-redirect", # Swagger UI 的 OAuth2 重定向 URL。当用户在 Swagger UI 中进行 OAuth2 授权时,将重定向到此 URL
swagger_ui_init_oauth: Optional[Dict[str, Any]] = None, # Swagger UI 的 OAuth2 初始化参数。你可以在这里设置 OAuth2 的初始值
middleware: Optional[Sequence[Middleware]] = None, # 中间件列表
exception_handlers: Optional[
Dict[
Union[int, Type[Exception]],
Callable[[Request, Any], Coroutine[Any, Any, Response]],
]
] = None, # 异常处理程序。你可以在这里添加自定义的异常处理程序
on_startup: Optional[Sequence[Callable[[], Any]]] = None, # 在应用程序启动时执行的函数列表
on_shutdown: Optional[Sequence[Callable[[], Any]]] = None, # 在应用程序关闭时执行的函数列表
terms_of_service: Optional[str] = None, # API 的服务条款。你可以在这里添加 API 的使用条款。
contact: Optional[Dict[str, Union[str, Any]]] = None, # API 的联系信息。你可以在这里添加 API 的联系人信息,例如电子邮件地址
license_info: Optional[Dict[str, Union[str, Any]]] = None, # API 的许可信息。你可以在这里添加 API 的许可证信息
openapi_prefix: str = "", # OpenAPI 文档的前缀。你可以在这里设置 API 文档的 URL 前缀。
root_path: str = "", # API 的根路径。你可以在这里设置 API 的根路径
root_path_in_servers: bool = True, # 是否将根路径包含在服务器列表中。如果设置为 True,根路径将被包含在服务器列表中。
responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None, # API 的响应定义。你可以在这里添加自定义的响应定义。
callbacks: Optional[List[BaseRoute]] = None, # 回调路由列表。你可以在这里添加自定义的回调路由
deprecated: Optional[bool] = None, # 是否标记 API 为已弃用。如果设置为 True,API 将被标记为已弃用
include_in_schema: bool = True, # 是否包含 API 在 OpenAPI 文档中。如果设置为 False,API 将不会出现在文档中
swagger_ui_parameters: Optional[Dict[str, Any]] = None, # Swagger UI 的参数。你可以在这里设置 Swagger UI 的参数。
**extra: Any,
-------------------------------------------
个性签名:代码过万,键盘敲烂!!!
如果觉得这篇文章对你有小小的帮助的话,记得在右下角点个“推荐”哦,博主在此感谢!