1. 介绍
FastAPI是一个基于Python 3.7+的现代化、高性能的Web框架,旨在帮助开发者更轻松地构建API。它结合了Python类型提示的优势和Starlette框架的性能,同时提供了自动生成文档的功能。本篇博客将通过实例演示FastAPI的基本用法和一些高级功能。
2. 安装FastAPI
首先,确保你的Python版本在3.7以上,然后使用以下命令安装FastAPI和uvicorn(用于运行ASGI应用的服务器):
pip install fastapi uvicorn
3. 第一个FastAPI应用
创建一个名为main.py
的文件,编写以下代码:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
return {"message": "Hello, World!"}
这个简单的应用定义了一个根路由(/
),当访问根路径时,返回一个包含消息的JSON。
4. 运行应用
使用以下命令运行应用:
uvicorn main:app --reload
访问http://127.0.0.1:8000
,你将看到返回的JSON消息。
5. 请求参数和类型提示
FastAPI通过类型提示强化了请求参数的声明。例如,添加一个带有路径参数的路由:
from fastapi import Path
@app.get("/items/{item_id}")
def read_item(item_id: int, query_param: str = None):
return {"item_id": item_id, "query_param": query_param}
在这个例子中,item_id
是一个路径参数,query_param
是一个可选的查询参数。FastAPI将自动解析这些参数,并且在文档中显示它们的类型和说明。
6. 请求体和响应模型
FastAPI支持请求体和响应模型的自动验证和生成文档。例如,创建一个接受JSON请求体的路由:
from pydantic import BaseModel
class Item(BaseModel):
name: str
description: str = None
price: float
tax: float = None
@app.post("/items/")
def create_item(item: Item):
return item
Item
是一个继承自BaseModel
的Pydantic模型,用于定义请求体的结构。FastAPI将根据模型生成文档,并且在接受请求时自动验证请求体。
7. 异步支持
FastAPI使用ASGI(Asynchronous Server Gateway Interface)来实现异步支持。可以使用async def
定义异步路由:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def read_root():
return {"message": "Hello, World!"}
8. 自动文档生成
FastAPI自动为应用生成交互式文档,可在http://127.0.0.1:8000/docs
中访问。这个文档基于Swagger UI,允许你测试API端点并查看请求和响应的结构。
9. 高级特性
FastAPI还支持许多高级特性,如依赖注入、跨域支持、WebSocket等。这些功能可以帮助你构建更复杂的Web应用。
结语
FastAPI是一个功能强大、易用的Web框架,特别适用于构建现代化的API。通过结合Python类型提示、Pydantic模型、自动文档生成等特性,FastAPI使得API的开发变得更加高效、可维护,并提供了出色的性能。希望通过这篇博客,你能对FastAPI有一个初步的了解,并开始尝试使用它构建自己的Web应用。