python-FastApi框架

FastApi

一. 简介

FastAPI 是一个用于构建 API 的现代、快速(高性能)的 web 框架,使用 Python 并基于标准的 Python 类型提示。

二. 特性

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

三. 安装

1. 安装 fastapi 模块

1
pip install fastapi

2. 安装 ASGI 服务器( Uvicorn 或者 Hypercorn)

1
pip install "uvicorn[standard]"

四. 实例

1. 创建main.py文件(GET 请求)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
from typing import Union

from fastapi import FastAPI

app = FastAPI()

# GET请求
@app.get("/")
def read_root():
return {"Hello": "World"}


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

2. 运行

1
uvicorn main:app --reload

–reload可以使之 mian:app 代码更新时服务器随之推送,即时更新

3. 测试

访问:https://127.0.0.1:8000/

可以得到一个 json 为{“Hello”: “World”}的数据

访问http://127.0.0.1:8000/items/5?q=somequery

可以得到一个 json 为{“item_id”: 5, “q”: “somequery”}的数据

与代码中read_root,read_item

4. 更新 main_py(加入 PUT 请求)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
name: str
price: float
is_offer: Union[bool, None] = None


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


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

# PUT请求
@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
return {"item_name": item.name, "item_id": item_id}

这里就不需要重新启动 uvicorn 服务了

五. 自动化 API 文档

1. Swagger UI(交互式文档)

访问 http://127.0.0.1:8000/docs
如图所示:
20240902084912

2. ReDoc(可选式文档)

访问 http://127.0.0.1:8000/redoc
如图所示:
20240902084931