python:Fastapi - 响应模型和状态码

本文介绍了FastAPI中响应模型的使用,包括如何声明响应模型以过滤返回数据,以及如何通过`ResponseModel`定义输出模型。同时,讨论了状态码的设置,如200、201、204、404等,并强调了不同状态码在不同场景下的应用。通过示例代码展示了如何在接口中定义和使用响应模型和状态码。
摘要由CSDN通过智能技术生成

简单絮叨一下

前面聊CookieHeader一些事情,今天主要聊聊关于响应的一些事情

响应就是接口的返回值,及状态码等,这个是必须要有的。其返回的数据主要是用于前端调试页面和测试进行测试的参考。




响应模型

fastapi只需要在任意路径(@app.get()@app.post()@app.put()@app.delete())操作中使用response_model 参数来声明用于响应的模型。

注意点: response_model是「装饰器」方法(getpost 等)的一个参数。不像之前的所有参数和请求体,它不属于路径操作函数。

from typing import List, Optional
from fastapi import FastAPI
from pydantic import BaseModel, EmailStr

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Optional[str] = None
    price: float
    tax: Optional[float] = None
    tagg: List[str] = []


@app.post("/items/", response_model=Item)
async def create_item(item: Item):
    return item

response_model就是定义返回值,因为response_modelItem赋值,请求接口后返回与输入的数据相同

启动服务:

PS E:\git_code\python-code\fastapiProject> uvicorn response_main:app --reload

请求接口:

POST http://127.0.0.1:8000/items

请求参数:

{
    "name": "张三",
    "price": 3.2
}

请求结果:

{
    "name": "张三",
    "description": null,
    "price": 3.2,
    "tax": null,
    "tagg": []
}

如果我们输入的是含密码的,那上述那种返回与输入相同的数据就不适合该需求了,那这样就得定义输出的模型:

from typing import List, Optional
from fastapi import FastAPI
from pydantic import BaseModel, EmailStr
from fastapi import status

app = Fas
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值