官方文档

https://fastapi.tiangolo.com/zh/

关键特性:

  • 快速：可与 NodeJS 和 Go 比肩的极高性能（归功于 Starlette 和 Pydantic）。最快的 Python web 框架之一。
  • 高效编码：提高功能开发速度约 200％ 至 300％。*
  • 更少 bug：减少约 40％ 的人为（开发者）导致错误。*
  • 智能：极佳的编辑器支持。处处皆可自动补全，减少调试时间。
  • 简单：设计的易于使用和学习，阅读文档的时间更短。
  • 简短：使代码重复最小化。通过不同的参数声明实现丰富功能。bug 更少。
  • 健壮：生产可用级别的代码。还有自动生成的交互式文档。
  • 标准化：基于（并完全兼容）API 的相关开放标准：OpenAPI (以前被称为 Swagger) 和 JSON Schema。

示例

下载安装包

pip install fastapi

pip install uvicorn[standard]

创建工作目录

mkdir common_faskapi

目录下创建 main.py 文件

touch main.py

我们使用async def

from typing import Optional

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
async def read_item(item_id: int, q: Optional[str] = None):
    return {"item_id": item_id, "q": q}

运行启动 默认8000端口

uvicorn main:app --reload
image-20220110223116256

浏览器访问 http://localhost:8000/

image-20220110223214570image-20220110224122829

再试下 http://127.0.0.1:8000/items/5?q=somequery

image-20220110223346851

你已经创建了一个具有以下功能的 API：

  • 通过 路径 / 和 /items/{item_id} 接受 HTTP 请求。
  • 以上 路径 都接受 GET 操作（也被称为 HTTP 方法）。
  • /items/{item_id} 路径 有一个 路径参数 item_id 并且应该为 int 类型。
  • /items/{item_id} 路径 有一个可选的 str 类型的 查询参数 q。

接口文档

还可以查看我们的接口文档 http://127.0.0.1:8000/docs

你会看到自动生成的交互式 API 文档（由 Swagger UI生成）：

查看文档 http://127.0.0.1:8000/docs#/default/read_item_items__item_id__get

image-20220110224122829

我们试下自己填写参数调用接口

image-20220110224348252image-20220110224409197

image-20220110224409197

至此我们一个简单的fastapi接口就实现了