python中的FastAPI
FastAPI 是一个现代、快速(高性能)的 Web 框架,用于构建 API,基于 Python 3.6+ 的类型提示。它利用了 Python 3.7+ 的新特性,如类型提示(Type Hints),来自动生成 API 文档(基于 OpenAPI 和 Swagger UI),以及进行参数校验和序列化/反序列化。FastAPI 旨在简化 API 开发,同时保持高性能。
FastAPI 的特点
- 快速:极高的性能,可与 Node.js 和 Go 媲美。
- 智能:基于 Python 类型提示自动完成许多工作,如数据验证、文档生成等。
- 简单:设计简洁,易于学习和使用。
- 标准:基于 OpenAPI(之前称为 Swagger)和 JSON Schema 的标准。
- 基于 Pydantic:数据声明使用 Pydantic,提供数据验证和设置管理。
- 依赖注入:强大的依赖注入系统。
- 可测试:直接测试你的 API 函数,就像测试普通 Python 函数一样。
- 可扩展:可以轻松扩展以支持多种数据库和其他后端服务。
示例代码
下面是一个简单的 FastAPI 示例,该示例创建了一个 API,用于获取和添加项目的列表。
首先,你需要安装 FastAPI 和 Uvicorn(一个轻量级的 ASGI 服务器,用于运行 FastAPI 应用程序):
pip install fastapi uvicorn
然后,你可以创建一个 Python 文件(例如 main.py
),并编写以下代码:
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
# 定义项目的 Pydantic 模型
class Item(BaseModel):
name: str
description: str = None
price: float
tax: float = None
# 获取项目列表的路由
@app.get("/items/")
async def read_items():
return [{"name": "Foo", "price": 35.4}, {"name": "Bar", "price": 42.2}]
# 创建一个新项目的路由
@app.post("/items/")
async def create_item(item: Item):
return item
最后,你可以使用 Uvicorn 运行你的 FastAPI 应用程序:
uvicorn main:app --reload
这条命令会启动你的应用程序,并监听在 http://127.0.0.1:8000
。--reload
参数意味着当代码更改时,服务器会自动重新加载。
现在,你可以使用浏览器或 Postman 等工具来测试你的 API。例如,访问 http://127.0.0.1:8000/items/
会显示一个项目列表。你也可以通过 POST 请求到 http://127.0.0.1:8000/items/
并附带 JSON 数据来创建一个新项目。
以上就是一个简单的 FastAPI 示例,展示了如何定义模型、路由和响应。