首页>文档>FastAPI>fastapi中文手册:Response Status Code(响应类型码)

fastapi中文手册:Response Status Code(响应类型码)

fastapi中文手册:Response Status Code(响应类型码)

FastAPI 是一个高性能 Web 框架,用于构建 API。

主要特性:

  • 快速:非常高的性能,与 NodeJS 和 Go 相当
  • 快速编码:将功能开发速度提高约 200% 至 300%
  • 更少的错误:减少约 40% 的人为错误
  • 直观:强大的编辑器支持,自动补全无处不在,调试时间更少
  • 简易:旨在易于使用和学习,减少阅读文档的时间。
  • 简短:减少代码重复。
  • 稳健:获取可用于生产环境的代码,具有自动交互式文档
  • 基于标准:基于并完全兼容 API 的开放标准 OpenAPI 和 JSON Schema 

一、status_code

你可以使用指定响应模型的相同方法,也可以在任何路径操作中使用参数status_code声明用于响应的HTTP状态代码:

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

from fastapi import FastAPI

app = FastAPI()

@app.post("/items/", status_code=201) 
async def create_item(name: str):
    return {"name": name}

注意

status_code装饰器’ 方法的参数(getpost等)。 不像所有参数和主体一样,具有路径操作功能。

status_code 参数接收带有HTTP状态代码的数字。

它会:

  • 在响应中返回该状态码。
  • 在OpenAPI架构中(以此类推,在用户界面中)将其记录为:
fastapi中文手册:Response Status Code(响应类型码)

二、关于 HTTP status codes

1. 复习:HTTP状态码

注意:

如果您已经知道HTTP状态代码是什么,请跳到下一部分。

在HTTP中,您将发送3位数的数字状态代码作为响应的一部分。

这些状态代码有一个识别它们的名称,但是重要的是数字。

简而言之:

  • 1** 及以上为“信息”。 您很少直接使用它们。
  • 2** 及以上是“成功”回复。 这些是您最常使用的。
    • 200 是默认状态码,表示一切正常。
    • 另一个例子是201,“ Created”。 通常在数据库中创建新记录后使用。
  • 3**及以上用于“重定向”。
  • 4** 及以上适用于“客户错误”响应。 这些是您可能最常使用的第二种类型。
    • 例如“404”,表示“未找到”响应。
    • 对于来自客户端的一般错误,您可以只使用400
  • 5** 及更高版本用于服务器错误。 您几乎永远不会直接使用它们。 如果您的应用程序代码或服务器中的某些部分出现问题,它将自动返回这些状态代码之一。

建议

想学习更多有关于HTTP状态码的信息,点击MDN documentation about HTTP status codes.

三、记住状态码的捷径

再一次查看之前的例子:

from fastapi import FastAPI

app = FastAPI()

@app.post("/items/", status_code=201) 
async def create_item(name: str):
    return {"name": name}

201 的状态码含义: “Created”.

但是你并不需要去记住每个状态码代码什么含义。

您可以使用starlette.status中的便捷变量。

from fastapi import FastAPI
from starlette.status import HTTP_201_CREATED 
app = FastAPI()

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

它们只是一种方便,它们具有相同的编号,但是这样您就可以使用编辑器的自动完成功能来找到它们:

fastapi中文手册:Response Status Code(响应类型码)

四、更改默认值

稍后,在教程/用户指南的更高级部分中,您将看到如何返回与默认状态不同的状态代码。

0 条回复 A文章作者 M管理员
    暂无讨论,说说你的看法吧
个人中心
购物车
优惠劵
今日签到
有新私信 私信列表
搜索