fastapi 全套教程

以下为 FastAPI 的全套教程：

1. FastAPI 简介

FastAPI 是一个现代化的 Python Web 框架，它使用了 Python 3.6+ 的新特性，如类型注释、异步和协程等。它提供了高性能、易于使用和易于扩展的 API 开发体验。

FastAPI 的主要特点：

- 快速：FastAPI 有着非常快的性能，可以达到甚至超过其他 Python Web 框架的速度。
- 易于使用：FastAPI 的 API 代码可读性非常高，开发者可以快速理解和使用。
- 自动文档：FastAPI 自动生成 API 文档，并支持交互式 API 文档界面。
- 异步支持：FastAPI 内置支持异步和协程，可以实现非阻塞 IO 和高并发。
- 安全性：FastAPI 内置了安全性功能，包括数据验证、身份验证和授权等。

2. 安装 FastAPI

安装 FastAPI 的最简单方法是使用 pip 包管理器：

pip install fastapi

安装完成后，您可以使用以下命令来检查 FastAPI 的版本：

pip show fastapi

3. 第一个 FastAPI 应用程序

创建一个名为 "main.py" 的文件，在其中编写以下代码：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

运行该应用程序：

uvicorn main:app --reload

打开浏览器，输入 http://localhost:8000，您将看到以下输出：

{"Hello": "World"}

4. 定义请求参数

FastAPI 支持多种类型的请求参数，包括路径参数、查询参数、请求体等。以下是一个示例：

from fastapi import FastAPI

app = FastAPI()

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

使用以下 URL 来测试该应用程序：

http://localhost:8000/items/42?q=test

您将看到以下输出：

{"item_id": 42, "q": "test"}

5. 定义响应模型

FastAPI 可以自动将响应数据转换为指定的模型类。以下是一个示例：

from fastapi import FastAPI
from pydantic import BaseModel

class Item(BaseModel):
    name: str
    price: float
    is_offer: bool = None

app = FastAPI()

@app.post("/items/")
async def create_item(item: Item):
    return item

使用以下命令来测试该应用程序：

curl -X POST "http://localhost:8000/items/" \
     -H "accept: application/json" \
     -H "Content-Type: application/json" \
     -d '{"name":"test item","price":9.99}'

您将看到以下输出：

{"name": "test item", "price": 9.99, "is_offer": null}

6. 自动文档

FastAPI 可以自动生成 API 文档，并支持交互式 API 文档界面。只需在浏览器中打开以下 URL 即可：

http://localhost:8000/docs

您将看到自动生成的文档和交互式界面。

7. 部署 FastAPI 应用程序

FastAPI 应用程序可以通过多种方式部署，包括使用服务器软件（如 Nginx、Apache）、使用容器技术（如 Docker）等。

以下是使用 Docker 部署 FastAPI 应用程序的示例：

创建一个名为 "Dockerfile" 的文件，包含以下内容：

FROM tiangolo/uvicorn-gunicorn-fastapi:python3.8

COPY ./app /app

在同一目录下创建一个名为 "app" 的目录，将 "main.py" 文件放在其中。

构建 Docker 镜像：

docker build -t fastapi-app .

运行 Docker 容器：

docker run -d --name fastapi-container -p 8000:80 fastapi-app

现在，您可以使用以下 URL 来访问 FastAPI 应用程序：

http://localhost:8000

以上就是 FastAPI 的全套教程，希望对您有所帮助。