当前位置：首页 > article >正文

python-FastApi框架

article 2025/2/22 16:35:23

文章目录

FastApi
- 一. 简介
- 二. 特性
- 三. 安装
- - 1. 安装fastapi模块
  - 2. 安装ASGI服务器( Uvicorn 或者 Hypercorn)
- 四. 实例
- - 1. 创建**main.py**文件(GET请求)
  - 2. 运行
  - 3. 测试
  - 4. 更新main_py(加入PUT请求)
- 五. 自动化API文档
- - 1. Swagger UI(交互式文档)
  - 2. ReDoc(可选式文档)

FastApi

一. 简介

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

二. 特性

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

三. 安装

1. 安装fastapi模块

pip install fastapi

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

pip install "uvicorn[standard]"

四. 实例

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

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. 运行

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请求)

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}