fastapi基本使用之：入参，返回值与异常处理

fastapi针对前后端分离的api操作做了相当多的订制，对于体现在入参、返回值以及异常处理上。

传入的参数可以有三种，路径参数，查询参数以及请求体。

参数的自动匹配，类型转换：

传统的web开发，需要开发同学自己从request.GET/POST里按字段去取值，然后自己转换类型。

fastapi直接把这些值取出来，并转到位，尤其是可以生成类（结构体），直接访问就好。

请求体
class Extra(BaseModel):message: Union[None, str] = None# 请求体
class Extra2(BaseModel):message2: Union[None, str] = None# 按约定，username自动识别为path, password自动识别为query
@router.post('/hello/{username}')
def hello(username: str, password: str, data: Extra, data2: Extra2):return {'username': username,'password': password,'data': data,'data2': data2}

常用的基本就够了，还是header参数，cookie参数等，都可以自动匹配取出来。

这里相比传统的django, flask框架，就是少了从request里读参数，判断类型，数据校验的问题。

下面说说错误处理。

fastapi推荐的HttpException在开发中不太实用，只要是接口正常，http_status_code都是200，然后在返回值里体现：

{
code: 0 服务正常/ -1 一般错误（参数错。。。）/ 1401 认证问题 / .....
msg: '错误描述'
data: 业务返回值可以是json，如 {page:1,count:10,list:[]}
}

可以拦截RequestValidationError，然后返回我们自定义的反馈，接口状态还是200，通过

code, message, data来表明具体错误原因。

@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request: Request, exc: RequestValidationError):"""捕获请求参数 验证错误:param request::param exc::return:"""# logger.error(f"参数错误\nURL:{request.url}\nHeaders:{request.headers}\n{traceback.format_exc()}")# print(traceback.format_exc())return JSONResponse(status_code=status.HTTP_200_OK,content=jsonable_encoder({"code": 10002, "message": "参数不全或参数错误","data": {"tip": exc.errors()}, "body": exc.body,}),)

最后是响应模型，通过response_model参数来设定。

通过HelloOut这个模型，可以过滤掉原来的字段，比如原来返回一个user类，要把password过滤掉就特别有用，同样，这个模型里设定的字段默认都是必填的，这就确保接口需要有正确的返回。

class HelloOut(BaseModel):username: strpassword: struser_id: int# 按约定，username自动识别为path, password自动识别为query, data, data2自动识别为Body
@router.post('/hello/{username}', response_model=HelloOut)
def hello(uid: int, username: str, password: str, data: Extra, data2: Extra2,start_datetime: Union[datetime, None] = Body(default=None),):return {'uid': uid,'username': username,'password': password,'data': data,'data2': data2,'start_dt': start_datetime,'user_id':123}

todo: 这里response_model如果校验错误，会返回500错误，如何拦截下来，并使用我们自定义的response的内容，待补充。

一个接口的基本使用就是这样，相比传统的api开发，就是输入参数不用自己管了，效率高且不容易出错，就是这样。

fastapi基本使用之：入参，返回值与异常处理相关推荐

spring入参为指定值，校验java入参的值为规定的值，利用Validator指定值校验注解——一看就会
我们在使用spring项目的时候,经常使用@Valid来对入参进行校验,比如必须为空,必须不为空,长度多少,是否符合邮件格式等等,同时也可以正则. 如下图所示, @Null(message = &qu ...
python如何改变入参的值_从事数据分析3年后，发现用python入门数据分析这三本书必看！...
做数据分析为什么选择python? 为什么选择python来做数据分析?先来看一下用python做数据分析有什么优势 1.python在数据分析方面有非常专业的模块,很多常用功能,在做数据分析时非常方 ...
ContentCachingRequestWrapper解决入参读取
如果在处理入参的时候发生了序列化等问题,在执行我们逻辑代码之前就会抛异常给总异常控制器.如果在总异常控制器通过inputStream读数据,是无法读到的,因为这个inputStream只支持读一次,无 ...
lua函数返回值 lua_call lua_getglobal lua_gettop(L)
lua函数返回值学习目标lua_call与返回值lua_pcalllua_getgloballua_gettop(L) //参数个数 lua_getglobal:把全局变量 name 里的值压入堆栈 ...
ARM 编程：C语言与汇编间互相调用，参数与返回值的传递方式详解
汇编基础: linux AT&T格式汇编简单框架函数调用时的规则如下: 父函数与子函数间的入口参数依次通过R0R3这4个寄存器传递.父函数在调用子函数前先将参数存入到R0R3中,若只有一个参 ...
Spring Boot 2.x（六）：优雅的统一返回值
目录为什么要统一返回值 ReturnVO ReturnCode 使用ReturnVO 使用AOP进行全局异常的处理云撸猫公众号为什么要统一返回值在我们做后端应用的时候,前后端分离的情况下,我 ...
java值参_Java陷阱之慎用入参做返回值详解
正常情况下,在Java中入参是不建议用做返回值的.除了造成代码不易理解.语义不清等问题外,可能还埋下了陷阱等你入坑. 问题背景比如有这么一段代码: @Named public class AServ ...
java什么时候用有参_Java有陷阱——慎用入参做返回值
正常情况下,在Java中入参是不建议用做返回值的.除了造成代码不易理解.语义不清等问题外,可能还埋下了陷阱等你入坑. 问题背景比如有这么一段代码: 上面代码,服务A希望调用服务B,以获取supply ...
java多线程测试框架（含入参和返回值）
最近要对一个webservice接口做测试,需测试高并发接口是否会以异常数据返回,编写了如下demo,有类似需求的可以参考下. 注意事项: 1,线程使用了callable接口形式,call相对runa ...

fastapi基本使用之：入参，返回值与异常处理

fastapi基本使用之：入参，返回值与异常处理相关推荐

最新文章

热门文章