FastAPI 是一个快速的 Web 框架,用于构建 API。它使用 Python 3.6+ 的新特性,例如类型注解和数据类,提供了强大的编译时性能和优化的开发体验。
以下是一个使用 FastAPI 创建的简单 API 示例:
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: str = None):
return {"item_id": item_id, "q": q}这个示例定义了两个路由:
/:当用户访问根路径时,返回一个包含 "Hello" 和 "World" 的 JSON 对象。/items/{item_id}: 当用户访问/items/<item_id>路径时,返回一个包含请求的item_id和查询参数q的 JSON 对象。如果q参数未提供,则默认为None。
为了运行这个 API,你需要安装 FastAPI 并启动应用:
pip install fastapi uvicorn
uvicorn main:app --reload这里 main 是文件名,app 是你在代码中创建的 FastAPI 实例。--reload 参数使得服务器在代码更改时自动重启,这在开发过程中很有用。