fastapi-简介

FastAPI 是一个用于构建 API 的现代、快速(高性能)的 web 框架,使用 Python 3.6+ 并基于标准的 Python 类型提示。有如下几个关键特性:

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

安装依赖

  • 安装fastapi
bash 复制代码
pip install fastapi
  • 安装uvicorn
python 复制代码
pip install uvicorn

示例

创建一个main.py并写入如下内容:

python 复制代码
from fastapi import FastAPI

app = FastAPI()

@app.get("/home")
async def home():
    return {"home": "ok"}

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

然后,我们可以通过以下命令来运行:

bash 复制代码
# app为fastapi实例名
uvicorn main:app --reload

又或者这样,我们修改一下代码:

python 复制代码
import uvicorn
from fastapi import FastAPI

app = FastAPI()

@app.get("/home")
async def home():
    return {"home": "ok"}

@app.get("/items/{item_id}")
async def items(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id}
    
if __name__ == "__main__":
    uvicorn.run(app, host="127.0.0.1", port=8000)

然后我们直接运行main.py文件即可!

等服务起来之后,我们可以在浏览器中访问http://localhost:8000/home,将会有如下返回:

json 复制代码
{
    "home": "ok"
}

另外,我们访问http://127.0.0.1:8000/docs会看到交互式的API文档(由SWAGGER UI生成)。或者访问http://127.0.0.1:8000/redoc,你会看到另一个自动生成的文档(由 ReDoc 生成)

操作

这里的「操作」指的是一种 HTTP「方法」。在fastapi中支持的HTTP方法有:

  • POST: 创建数据
  • GET: 读取数据
  • PUT: 更新数据
  • DELETE: 删除数据

比较常用的有这4种操作,当然fastapi也支持其他几种少见的HTTP方法:

  • OPTIONS
  • HEAD
  • PATCH
  • TRACE

在 HTTP 协议中,你可以使用以上的其中一种(或多种)「方法」与每个路径进行通信。

我们可以使用FastAPI的实例来访问这些操作,如下:

python 复制代码
@app.get("/")
async def get_action():
    pass

@app.post("/")
async def post_action():
    pass

@app.delete("/")
async def delete_action():
    pass


@app.put("/")
async def put_action():
    pass

函数的返回可以是一个dictlist,也可以是像strint一样的单个值,等等。

你还可以返回Pydantic模型(稍后你将了解更多)。

相关推荐
MessiGo5 分钟前
Python 爬虫 (1)基础 | 基础操作
开发语言·python
肥猪猪爸29 分钟前
使用卡尔曼滤波器估计pybullet中的机器人位置
数据结构·人工智能·python·算法·机器人·卡尔曼滤波·pybullet
LZXCyrus1 小时前
【杂记】vLLM如何指定GPU单卡/多卡离线推理
人工智能·经验分享·python·深度学习·语言模型·llm·vllm
Enougme1 小时前
Appium常用的使用方法(一)
python·appium
懷淰メ1 小时前
PyQt飞机大战游戏(附下载地址)
开发语言·python·qt·游戏·pyqt·游戏开发·pyqt5
hummhumm1 小时前
第 22 章 - Go语言 测试与基准测试
java·大数据·开发语言·前端·python·golang·log4j
hummhumm2 小时前
第 28 章 - Go语言 Web 开发入门
java·开发语言·前端·python·sql·golang·前端框架
每天吃饭的羊2 小时前
python里的数据结构
开发语言·python
卡卡_R-Python2 小时前
UCI Heart Disease Data Set—— UCI 心脏病数据集介绍
python·plotly·django·virtualenv·pygame
饮长安千年月2 小时前
浅谈就如何解出Reverse-迷宫题之老鼠走迷宫的一些思考
python·网络安全·逆向·ctf