FastAPI 构建 API 服务,究竟有多快?

FastAPI 干啥的?

FastAPI 是用来构建 API 服务的一个高性能框架。

为什么选择 FastAPI ?

FastAPI 是一个现代、高性能 web 框架,用于构建 APIs,基于 Python 3.6 及以上版本。

最大特点:快!性能极高,可与 NodeJS, Go 媲美。

基于 Starlette 和 Pydantic,是 FastAPI 如此高性能的重要原因。

还具备代码复用性高,容易上手,健壮性强的优点。

个人还觉得,FastAPI 还有一个非常强的优势:方便的 API 调试,生成 API 文档,直接能够做到调试自己构建的 API,这在实际应用中,价值凸显。

FastAPI 这么强悍,有必要研究和使用,因为无论做开发,还是做算法,API 服务真的太重要,太重要,尤其是大厂,离不开 API 接口。

Pydantic 做类型强制检查

FastAPI 基于 PydanticPydantic 主要用来做类型强制检查。参数赋值,不符合类型要求,就会抛出异常。

对于 API 服务,支持类型检查非常有用,会让服务更加健壮,也会加快开发速度,因为开发者再也不用自己写一行一行的做类型检查。

首先 pip install pydantic

然后,使用 Pydantic 做强制类型检查。

from pydantic import ValidationError

from datetime import datetime
from typing import List
from pydantic import BaseModel

class User(BaseModel):
    id:int
    name='jack guo'
    signup_timestamp: datetime = None
    friends: List[int] = []

观察到:

  • id 要求必须为 int

  • name 要求必须为 str, 且有默认值

  • signup_timestamp 要求为 datetime, 默认值为 None

  • friends 要求为 List,元素类型要求 int, 默认值为 []

使用 User 类:

try:
    User(signup_timestamp='not datetime',friends=[1,2,3,'not number'])
except ValidationError as e:
    print(e.json())

id 没有默认值,按照预期会报缺失的异常

signup_timestamp 被赋为非 datetime 类型值,按照预期会报异常

friends 索引为 3 的元素被赋值为 str,按照预期也会报异常

执行代码,验证是否符合预期。

执行结果显示,符合预期

[
  {
    "loc": [
      "id"
    ],
    "msg": "field required",
    "type": "value_error.missing"
  },
  {
    "loc": [
      "signup_timestamp"
    ],
    "msg": "invalid datetime format",
    "type": "value_error.datetime"
  },
  {
    "loc": [
      "friends",
      3
    ],
    "msg": "value is not a valid integer",
    "type": "type_error.integer"
  }
]

快速上手 FastAPI

这是一个入门 demo, 构建以下三个路由:

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class User(BaseModel):
    id: int
    name: str
    friends: list


@app.get("/")
def index():
    return {"admin": "welcome to FastAPI"}


@app.get("/users/{user_id}")
def read_user(user_id: int, name: str = None):
    return {"user_id": user_id, "name": name}


@app.put("/users/{user_id}")
def update_user(user_id: int, user: User):
    return {"user_name": user.name, "user_id": user_id}

将上述代码保存为 main.py

再安装与构建服务相关的框架 uvicorn

安装完成后,后台执行:uvicorn main:app --reload 

启动服务,显示如下:

打开客户端,输入:localhost:8000,回车:

输入请求:localhost:8000/users/5,回车,看到前台数据,非常容易的就能传递到 controller 层,方便。

  输入请求:localhost:8000/docs,回车:,看到 API 文档界面

  点开第二个 get 请求,然后点击 Try it out 后,便可以进行接口调试。非常方便!

 输入user_id, name 后,点击 Execute,执行成功。如果 user_id 输入非数值型,点击 Execute 后,红框闪动一下,不会执行,直到输入正确为止。

 输入user_id, name 后,点击 Execute,

能看到结果,包括请求的 URL

 也能看到,服务器响应前端,返回的结果:

FastAPI 基于以上这些强大的优点,相信在实际开发 API 服务时,会很敏捷。期待!

推荐阅读:

  1. 为什么魂斗罗只有128KB却可以实现那么长的剧情?

  2. 假如有人把支付宝存储服务器炸了,里面的钱是不是就都没有了?

  3. 当输入 xxxxHub 后,到网页显示,其间发生了什么?这问题被面试官问了五六十次,熬夜赶出这篇文章

展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 大白 设计师: CSDN官方博客
应支付0元
点击重新获取
扫码支付

支付成功即可阅读