FastAPI（20）- Response Status Code 响应状态码

2022-05-15 245

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： FastAPI（20）- Response Status Code 响应状态码

前言

和指定响应模型一样，可以在任何路径操作中添加参数 status_code，用于声明响应的 HTTP 状态码

@app.get()
@app.post()
@app.put()
@app.delete()

最简单的栗子

#!usr/bin/env python
# -*- coding:utf-8 _*-
"""
# author: 小菠萝测试笔记
# blog:  https://www.cnblogs.com/poloyy/
# time: 2021/9/21 10:27 下午
# file: 18_status_code.py
"""
import uvicorn
from fastapi import FastAPI
app = FastAPI()
@app.post("/items/", status_code=201)
async def create_item(name: str):
    return {"name": name}
if __name__ == "__main__":
    uvicorn.run(app="18_status_code:app", host="127.0.0.1", port=8080, reload=True, debug=True)

重点

status_code 接收一个带有 HTTP 状态代码的 number
status_code 也可以接收一个 IntEnum
如果是 number，可以使用 from fastapi import status ，里面都是封装好的状态码变量，直接调用即可
如果是 IntEnum，可以使用 from http import HTTPStatus ，是一个 int 类型的枚举类

status 的栗子

from fastapi import status
app = FastAPI()
@app.post("/items/", status_code=status.HTTP_201_CREATED)
async def create_item(name: str):
    return {"name": name}

更推荐用这个，因为变量名会包含状态码+含义
fastapi.status 是直接来自 starlette.status ，提供的东西都是一样的

HTTPStatus 的栗子

from http import HTTPStatus
app = FastAPI()
@app.post("/items/", status_code=HTTPStatus.CREATED)
async def create_item(name: str):
    return {"name": name}