首页 > 其他分享 >FastAPI系统:FastAPI类参数说明

FastAPI系统:FastAPI类参数说明

时间:2024-02-28 16:47:46浏览次数:160  
标签:None FastAPI 说明 API 参数 str Dict Optional Any

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,

标签:None,FastAPI,说明,API,参数,str,Dict,Optional,Any
From: https://www.cnblogs.com/weiweivip666/p/18040978

相关文章

  • CrystalDiskMark使用说明
    CrystalDiskMark使用说明CrystalDiskMark(CDM)是一个用于评估硬盘和固态硬盘性能的流行工具。它是由CrystalDewWorld公司开发的,是一款免费的磁盘性能测试实用程序。CrystalDiskMark提供了一个直观的界面,使用户能够轻松地测试磁盘的读写速度,并获取详细的性能数据。官方网站地......
  • 统一异常处理@ControllerAdvice及参数校验@Validated
    一、异常处理有异常就必须处理,通常会在方法后面throws异常,或者是在方法内部进行trycatch处理。直接throwsException直接throwsException,抛的异常太过宽泛,最好能抛出准确的异常,比如throwsIOException之类。UsergetUserById(Integerid)throwsIOException,BusinessE......
  • 解决HttpServletRequest调用getInputStream()方法读取参数只能获取一次问题
    1、问题描述由于后端接口获取前端传过的参数是通过HttpServletRequest接收获取的。现有一需求需要在接口调用之前拦截接口进行业务处理。在拦截类中调用getInputStream()获取参数之后,在接口方法里获取参数为空。2、解决方法自定义一个过滤器过滤所有请求,使用HttpServletRequest......
  • Sentinel系列之(六)热点参数限流规则
    热点参数限流规则......
  • 去除窗体边框代码说明
    去除窗体边框1.属性中设置边框BorderStyle=bsNone2.ClientEvents-UniEvents事件中写代码functionwindow.beforeInit(sender){Ext.apply(sender,{border:false,baseCls:'',//这个很关键背景透明shadow:false,frame:false,//width:400,//height:......
  • Mybatis系列之(七)参数深入
    参数深入1.ParameterType(输入类型)1.1通过ParameterType传递Pojo对象Mybatis使用ognl表达式解析对象字段的值ognl表达式objectgraphicnavigationlanguage对象图导航语言通过对象的取值方法(属性的get方法)来获取数据,在写法上把get给省略了......
  • SpringMVC系列之(四)请求参数的绑定
    请求参数的绑定获取前端传过来的参数的过程,如:Servlet的getParameter方法SpringMVC中的请求参数绑定:通过反射实现,SpringMVC中的请求参数绑定过程是把表单提交的请求参数,作为控制器中方法的参数进行绑定的。1.支持的数据类型基本数据类型和字符串实体类型(JavaBean)集合数据类......
  • pickBy 在前端开发中的最佳实践和使用场景举例说明
    pickBy是lodash中的一个函数,其作用是过滤对象中的属性,只保留符合条件的属性。它的用法如下:_.pickBy(object,[predicate=_.identity])其中,object是要过滤的对象,predicate是一个可选的函数,用于定义过滤条件。如果没有传入predicate函数,则默认使用_.identity函数,即返回......
  • 3d max的obj文件格式说明
    OBJ文件格式是一种常见的3D模型文件格式,它包含了模型的几何形状、材质、纹理等信息。下面是OBJ文件格式的一些基本信息:OBJ文件由一系列文本行组成,每行以一个关键字开头,关键字后面跟着一些参数。OBJ文件中最常见的关键字有以下几个:v:定义一个顶点,后面跟着该顶点的x、y、z......
  • springboot 统一处理请求非法参数
    通过拦截器和过滤器实现,话不多说上代码。1、重写HttpServletRequestWrapper读取body里面的内容。publicclassRequestWrapperextendsHttpServletRequestWrapper{privatefinalStringbody;publicRequestWrapper(HttpServletRequestrequest){super......