FastAPI 是一个现代、快速(高性能)的 Web 框架,用于构建 API,与 Python 3.6+ 类型提示一起使用。

快速开始

  1. 安装 FastAPI 使用 pip 安装 FastAPI:

    pip install fastapi
    
  2. 创建一个基本的 FastAPI 应用

    创建一个名为 main.py 的文件,并添加以下内容:

    from fastapi import FastAPI
    
    app = FastAPI()
    
    @app.get("/")
    async def root():
        return {"message": "Hello World"}
    

    现在您已经创建了一个基本的 FastAPI 应用程序。

  3. 运行您的应用

    在命令行中运行以下命令:

    uvicorn main:app --reload
    

    这将启动一个开发服务器。

  4. 访问您的 API

    打开浏览器并访问 http://127.0.0.1:8000/,您应该会看到以下响应:

    {
        "message": "Hello World"
    }
    

路由和响应

FastAPI 使用 Python 函数来定义路由和响应。以下是一个简单的路由示例:

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

在这个例子中,我们定义了一个路由 /items/{item_id},它接受一个名为 item_id 的参数,并返回一个包含该参数值的 JSON 响应。

数据验证

FastAPI 使用 Pydantic 来验证和序列化数据。以下是一个使用 Pydantic 模型的示例:

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

在这个例子中,我们定义了一个 Item 模型,它包含一个必填的 name 字段,一个可选的 description 字段,一个必填的 price 字段和一个可选的 tax 字段。

更多信息

要了解更多关于 FastAPI 的信息,请访问我们的官方文档

FastAPI Logo