Python FastAPI 框架入门（一）【用于后端API快捷开发】

news2024/11/25 14:55:41

在这里插入图片描述
FastAPI 框架，高性能，易于学习，高效编码，生产可用
官方中文文档：FastAPI 框架中文文档
官方介绍：

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

1、安装FastAPI

当然默认你有Python基础并已经安装 Python 3.6+了

依赖
Python 3.6 及更高版本
FastAPI 依赖 Starlette 和 Pydantic ：
Starlette 负责 web 部分。
Pydantic 负责数据部分。

安装fastapi 和 ASGI 服务器（生产环境可以使用 Uvicorn 或者 Hypercorn）

$ pip install fastapi
$ pip install "uvicorn[standard]"

2、第一个示例

创建一个 main.py 文件并写入以下内容:

from typing import Union

from fastapi import FastAPI

app = FastAPI()


@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}

运行

$ uvicorn main:app --reload

在这里插入图片描述

测试效果

使用浏览器访问 http://127.0.0.1:8000/
在这里插入图片描述
使用浏览器访问 http://127.0.0.1:8000/items/5?q=somequery

3、交互式 API 文档（测试API）

3.1 由 Swagger UI生成的（推荐）

访问 http://127.0.0.1:8000/docs
在这里插入图片描述

3.2 由 ReDoc 生成（可选的）

访问 http://127.0.0.1:8000/redoc
在这里插入图片描述

4、接受put请求

现在修改 main.py 文件来从 PUT 请求中接收请求体。
借助 Pydantic 来使用标准的 Python 类型声明请求体。

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}


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