FastAPI学习-2(fastapi参数详解)

最新推荐文章于 2024-08-12 01:16:55 发布

开始减肥的瘦马

最新推荐文章于 2024-08-12 01:16:55 发布

阅读量6k

点赞数 2

文章标签： python

本文链接：https://blog.csdn.net/m0_47671192/article/details/106195857

版权

本文详细介绍了FastAPI的参数配置，包括debug、routes、title、description、version等，并提供了示例。debug用于设置调试模式，routes存储路由列表，title和description定义API的标题和描述，version指定接口的版本号。此外，还讨论了default_response_class（默认响应类型）、docs_url和redoc_url（文档路径），以及中间件、异常处理、启动和关闭时的回调函数等高级特性。

摘要由CSDN通过智能技术生成

1.查看FastAPI源码
在这里插入图片描述
参数如下：

debug: 调试模式，True/False,此属性继承自starlette，在starlette中使用的是property装饰器
routes:路由列表，默认值为None,此属性继承自starlette，类型为startlette的BaseRoute列表，BaseRoute与starlette的基础类型Scope有关
title: API文档的标题，默认值FastAPI
description: API文档的描述，默认为空
version: API接口的版本号
openapi_url: OpenAPI文件路径，默认为/opanapi.json
openapi_prefix: OpenAPI文件路径前缀，默认为空
default_response_class: 默认响应类型，默认为JSONResponse,此参数继承自startlette的Response，有HTMLResponse、PlainTextResponse、UJSONResponse、RedirectResponse、StreamingResponse、FileResponse和JSONResponse七种，使用时需加载starlette.responses模块
docs_url: 交互式文档路径，默认为docs
redoc_url: 可选式文档路径，默认为redoc
swagger_ui_oauth2_redirect_url: OAuth重定向路径，默认为/docs/oauth2-redirect
swagger_ui_init_oauth: OAuth重定向字典，默认为None
middleware: 中间件，默认为空
exception_handlers: 异常处理方法，默认为None
on_startup: app启动时调用的方法列表
on_shutdown: app关闭时调用的方法列表
extra: 额外可选参数
例子：
debug: 这个参数不多做说明
routes：路由列表，代码如下：

from fastapi import FastAPI
from starlette.responses import JSONResponse #此类型不可少
from starlette.routing import Route


# request参数不可少
async def homepage(request):
    return JSONResponse({
   "index":"主页"}) #此类型格式化不可少


# request参数不可少
async def about(request):
    return JSONResponse({
   "index":"关于"}) #此类型格式化不可少

r