最牛逼的 Python Web 服务:FastAPI 入门指南
FastAPI 是一个现代、快速(高性能)的 Web 框架,用于构建 APIs。它基于 Python 3.6+ 的类型提示,使用 Starlette(用于网络部分)和 Pydantic(用于数据验证)。下面我们将深入了解 FastAPI 的核心特性,并通过简单的示例展示其强大之处。
什么是 FastAPI?
FastAPI 是为构建高性能 Web 应用和 API 而设计的,具有以下优势:
- 速度快:基于 Starlette,FastAPI 是现有最快的 Python Web 框架之一。
- 自动生成文档:支持 Swagger UI 和 ReDoc,自动生成文档。
- 类型安全:使用 Python 类型提示,减少运行时错误。
FastAPI 的安装
首先,我们需要安装 FastAPI 和一个 ASGI 服务器,例如 Uvicorn。可以使用以下命令进行安装:
pip install fastapi uvicorn
创建第一个 FastAPI 应用
下面是一个简单的 FastAPI 应用示例,展示了如何构建一个 API。
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
在上面的代码中,我们创建了一个 FastAPI 实例 app
,并定义了一个根路由(/
),当访问这个路由时,会返回一个 JSON 响应 {"Hello": "World"}
。
运行 FastAPI 应用
要运行应用,使用以下命令启动 Uvicorn 服务器:
uvicorn main:app --reload
main
是包含 FastAPI 应用的 Python 文件名(不带.py
后缀)。--reload
选项用于在代码更改时自动重载服务器。
访问 http://127.0.0.1:8000,你会看到 {"Hello": "World"}
的输出。
路由和参数
FastAPI 允许轻松创建具有路径参数和查询参数的路由。例如,创建一个简单的乘法器 API:
@app.get("/multiply/{num1}/{num2}")
def multiply(num1: int, num2: int):
return {"result": num1 * num2}
在这个例子中,访问 http://127.0.0.1:8000/multiply/3/5 将返回 {"result": 15}
。
请求体和数据验证
FastAPI 的强大之处在于数据验证。我们可以使用 Pydantic 创建请求体模型:
from pydantic import BaseModel
class Item(BaseModel):
name: str
price: float
tax: float = None
@app.post("/items/")
def create_item(item: Item):
return {"item": item}
在这个例子中,当你发送一个包含 JSON 数据的 POST 请求到 /items/
时,FastAPI 会自动验证数据,并返回接收到的项目。
自动生成文档
FastAPI 自动为我们的 API 生成文档。访问 http://127.0.0.1:8000/docs 可以查看基于 Swagger 的文档,或者访问 http://127.0.0.1:8000/redoc 查看 ReDoc 文档。这使得 API 的使用和测试变得非常简单。
异步支持
FastAPI 还支持异步编程,通过 async
和 await
关键字来实现。例如:
@app.get("/async")
async def read_async():
return {"message": "This is an async route!"}
通过这种方式,你可以提高应用的并发性能。
总结
FastAPI 是构建高性能 Web 服务的最佳选择,凭借其简单易用的语法、强大的数据验证、自动生成文档的特性以及对异步编程的支持,让开发者能够快速高效地构建和维护 API。无论是小型项目还是大型应用,FastAPI 都是一个值得考虑的框架。