FastAPI 入门指南：构建你的第一个API

FastAPI 入门指南：构建你的第一个API

fastapi FastAPI framework, high performance, easy to learn, fast to code, ready for production 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi

什么是FastAPI？

FastAPI 是一个现代、快速（高性能）的 Python Web 框架，用于构建 API。它基于标准 Python 类型提示，使用 Starlette 和 Pydantic 构建，提供了极高的性能，可与 NodeJS 和 Go 相媲美。

创建你的第一个FastAPI应用

1. 安装FastAPI

在开始之前，你需要安装FastAPI和ASGI服务器（如Uvicorn）：

pip install fastapi uvicorn

2. 编写基础代码

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

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

这段代码做了以下几件事：

1. 导入FastAPI类
2. 创建FastAPI实例（通常命名为app）
3. 定义路由处理函数
4. 返回JSON响应

3. 运行开发服务器

在终端运行以下命令启动开发服务器：

fastapi dev main.py

你会看到类似以下的输出：

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

这表示你的API已经在本地运行，可以通过浏览器或API客户端访问。

测试你的API

1. 直接访问API端点

打开浏览器访问http://127.0.0.1:8000，你会看到返回的JSON数据：

{"message": "Hello World"}

2. 使用交互式API文档

FastAPI的一个强大特性是自动生成的交互式API文档。访问以下URL可以查看：

• Swagger UI文档：http://127.0.0.1:8000/docs
• ReDoc文档：http://127.0.0.1:8000/redoc

这些文档不仅展示了API的结构，还允许你直接测试API端点。

代码解析

让我们更详细地分析这段代码：

1. FastAPI实例

app = FastAPI()

这行代码创建了FastAPI的核心实例，所有API路由和设置都将基于这个实例。

2. 路径操作装饰器

@app.get("/")

这个装饰器告诉FastAPI：

• 处理HTTP GET请求
• 路径为根路径("/")
• 下面的函数将处理这个请求

3. 路径操作函数

async def root():
    return {"message": "Hello World"}

这是一个异步函数，它处理请求并返回响应。在FastAPI中，你可以：

• 使用async def定义异步函数
• 使用普通def定义同步函数
• 返回Python字典，FastAPI会自动将其转换为JSON

FastAPI的核心特性

1. 自动文档生成

FastAPI基于OpenAPI标准自动生成API文档，支持：

• Swagger UI（交互式文档）
• ReDoc（替代文档界面）
• OpenAPI JSON（机器可读的API描述）

2. 类型安全

通过Python类型提示，FastAPI提供：

• 自动数据验证
• 自动数据序列化
• 编辑器支持（自动补全等）

3. 高性能

FastAPI构建在Starlette和Pydantic之上，性能接近原生Go和NodeJS。

进阶概念

1. 路径参数

你可以定义带参数的路径，如：

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

2. 查询参数

FastAPI自动处理URL查询参数：

@app.get("/items/")
async def read_item(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}

3. 请求体

使用Pydantic模型处理请求体：

from pydantic import BaseModel

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

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

总结

通过这篇指南，你已经学会了：

1. 如何创建基本的FastAPI应用
2. 如何定义路由和处理函数
3. 如何运行开发服务器
4. 如何测试API
5. FastAPI的核心特性和优势

FastAPI的设计理念是让开发者能够快速构建高性能的API，同时保持代码的简洁和可维护性。随着你继续深入学习，你会发现更多强大的功能，如依赖注入、安全性、后台任务等。

下一步，你可以尝试添加更多路由、处理不同类型的请求，或者集成数据库来构建更复杂的应用。

fastapi FastAPI framework, high performance, easy to learn, fast to code, ready for production 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi