Python FastAPI 库基本使用指南

Shaw0xyz

1. 引言

FastAPI是一个基于Python的现代Web框架，因其高性能和简单易用而备受欢迎。FastAPI使用Python 3.6及以上版本的类型提示和异步功能，使得构建快速、高效的API变得更加容易。本文将介绍FastAPI的基本使用方法，帮助读者快速上手这一强大的Web框架。

1.1 FastAPI的安装

在开始使用FastAPI之前，需要先安装它。推荐使用pip进行安装：

1. pip install fastapi
   
2. pip install "uvicorn[standard]"

复制代码

Uvicorn是一个轻量级的ASGI服务器，用于运行FastAPI应用程序。

1.2 创建第一个FastAPI应用

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

1. from fastapi import FastAPI
   
2. 
   
3. app = FastAPI()
   
4. 
   
5. @app.get("/")
   
6. def read_root():
   
7.     return {"message": "Hello, World!"}

复制代码

这个简单的应用定义了一个GET请求的根路径（/），返回一个包含问候消息的JSON响应。

1.3 运行FastAPI应用

使用Uvicorn运行FastAPI应用：

uvicorn app:app --reload

其中，app:app指的是app模块中的app实例。--reload选项用于在代码更改时自动重新加载服务器。

1.4 路由与请求处理

FastAPI支持多种HTTP方法（GET、POST、PUT、DELETE等）和路径参数。以下示例展示了如何定义多个路由和处理请求：

1. from fastapi import FastAPI
   
2. 
   
3. app = FastAPI()
   
4. 
   
5. @app.get("/")
   
6. def read_root():
   
7.     return {"message": "Hello, World!"}
   
8. 
   
9. @app.get("/items/{item_id}")
   
10. def read_item(item_id: int):
    
11.     return {"item_id": item_id}
    
12. 
    
13. @app.post("/items/")
    
14. def create_item(name: str):
    
15.     return {"name": name}
    

复制代码

1.5 数据验证与类型提示

FastAPI利用Pydantic进行数据验证和序列化。可以通过定义Pydantic模型来验证请求数据。以下示例展示了如何使用Pydantic模型：

1. from fastapi import FastAPI
   
2. from pydantic import BaseModel
   
3. 
   
4. app = FastAPI()
   
5. 
   
6. class Item(BaseModel):
   
7.     name: str
   
8.     description: str = None
   
9.     price: float
   
10.     tax: float = None
    
11. 
    
12. @app.post("/items/")
    
13. def create_item(item: Item):
    
14.     return item
    

复制代码

在此示例中，定义了一个Item模型，并在POST请求中使用它来验证请求数据。

1.6 异步支持

FastAPI原生支持异步编程，可以使用async def定义异步路由处理函数：

1. 
   
2. import asyncio
   
3. from fastapi import FastAPI
   
4. 
   
5. app = FastAPI()
   
6. 
   
7. @app.get("/async")
   
8. async def read_async():
   
9.     await asyncio.sleep(1)
   
10.     return {"message": "This is an async response"}
    

复制代码

1.7 自动生成文档

FastAPI自动生成交互式API文档，默认提供Swagger UI和ReDoc文档。启动应用后，可以通过以下URL访问文档：

Swagger UI: http://127.0.0.1:8000/docs  
ReDoc: http://127.0.0.1:8000/redoc  

1.8 中间件与依赖注入

FastAPI支持中间件和依赖注入，使得在请求处理过程中执行特定操作变得更加方便。以下是一个简单的中间件示例：

1. from fastapi import FastAPI, Request
   
2. 
   
3. app = FastAPI()
   
4. 
   
5. @app.middleware("http")
   
6. async def add_custom_header(request: Request, call_next):
   
7.     response = await call_next(request)
   
8.     response.headers["X-Custom-Header"] = "Custom value"
   
9.     return response
   

复制代码

1.9 结论

FastAPI是一个强大且高效的Web框架，通过类型提示和异步支持简化了API开发过程。本文介绍了FastAPI的基本使用方法，包括安装、路由与请求处理、数据验证、异步支持、自动生成文档以及中间件。希望本文能帮助读者快速上手FastAPI，并在实际项目中充分利用其优势。