Python如何构建REST API?FastAPI框架快速入门

来源:Golang编程网作者:北京GEO公司头衔:草根站长
导读:本期聚焦于小伙伴创作的《Python如何构建REST API?FastAPI框架快速入门》,敬请观看详情,探索知识的价值。以下视频、文章将为您系统阐述其核心内容与价值。如果您觉得《Python如何构建REST API?FastAPI框架快速入门》有用,将其分享出去将是对创作者最好的鼓励。

Python生态中有很多用于构建Web API的框架,FastAPI是近年来热度很高的选择,它基于Starlette和Pydantic构建,支持异步编程,性能表现优异,同时自带OpenAPI规范支持,可自动生成交互式接口文档,非常适合快速开发REST API。

Python如何构建REST API?FastAPI框架快速入门

环境准备

首先需要安装FastAPI和用于运行服务的ASGI服务器uvicorn,执行以下命令即可完成安装:

pip install fastapi uvicorn

第一个FastAPI接口

创建一个名为main.py的文件,编写最简单的接口代码:

from fastapi import FastAPI

# 初始化FastAPI应用实例
app = FastAPI()

# 定义根路径的GET请求接口
@app.get("/")
def read_root():
    return {"message": "Hello, FastAPI"}

运行服务使用以下命令:

uvicorn main:app --reload

启动后访问127.0.0.1:8000,就能看到接口返回的JSON数据。同时访问127.0.0.1:8000/docs可以打开自动生成的交互式接口文档,直接在页面上测试接口。

定义带路径参数的接口

REST API经常需要接收路径中的参数,比如获取指定ID的用户信息,FastAPI可以直接在函数参数中声明路径参数:

from fastapi import FastAPI

app = FastAPI()

# 路径参数item_id,类型为int
@app.get("/items/{item_id}")
def read_item(item_id: int):
    return {"item_id": item_id, "name": f"Item_{item_id}"}

FastAPI会自动对路径参数做类型校验,如果传入的item_id不是数字,会直接返回对应的错误提示。

处理查询参数

除了路径参数,接口还经常需要接收查询参数,比如分页参数、筛选条件等,查询参数不需要在路径中声明,直接在函数参数中定义即可:

from fastapi import FastAPI

app = FastAPI()

@app.get("/users/")
def read_users(skip: int = 0, limit: int = 10):
    # 模拟用户数据
    users = [{"id": i, "name": f"User_{i}"} for i in range(1, 21)]
    return users[skip: skip + limit]

访问/users/?skip=5&limit=5就可以获取第6到第10条用户数据,查询参数也支持类型声明,FastAPI会自动做类型转换和校验。

使用Pydantic定义请求体

当接口需要接收POST请求的JSON数据时,可以使用Pydantic的模型来定义请求体的结构,FastAPI会自动做数据校验和解析:

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

# 定义请求体模型
class Item(BaseModel):
    name: str
    price: float
    is_offer: bool = None

@app.post("/items/")
def create_item(item: Item):
    return {"item_name": item.name, "item_price": item.price, "is_offer": item.is_offer}

发送POST请求到/items/,传入符合Item结构的JSON数据,FastAPI会自动解析并校验数据,不符合要求会返回明确的错误提示。

常用功能扩展

FastAPI还支持很多REST API常用的功能,比如:

  • 响应模型:通过response_model参数指定接口返回的数据结构,自动过滤多余字段
  • 异常处理:使用HTTPException抛出指定状态码和错误信息的异常
  • 依赖注入:通过Depends实现公共逻辑复用,比如鉴权、数据库连接等
  • 异步支持:接口函数可以使用async def定义,支持异步操作,提升高并发场景下的性能

以下是一个带响应模型和异常处理的接口示例:

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from typing import Optional

app = FastAPI()

class ItemResponse(BaseModel):
    item_id: int
    name: str
    price: float

fake_db = {
    1: {"name": "Item1", "price": 10.5},
    2: {"name": "Item2", "price": 20.0}
}

@app.get("/items/{item_id}", response_model=ItemResponse)
def read_item(item_id: int):
    if item_id not in fake_db:
        raise HTTPException(status_code=404, detail="Item not found")
    item_data = fake_db[item_id]
    return {"item_id": item_id, **item_data}

通过以上内容,已经可以覆盖大部分基础REST API的开发需求,FastAPI的官方文档还有更多高级用法可以查阅学习,能够快速满足各类API开发场景的需要。

PythonFastAPIREST_APIAPI开发修改时间:2026-06-24 01:42:17

免责声明:​ 已尽一切努力确保本网站所含信息的准确性。网站内容多为原创整理与精心编撰,观点力求客观中立。本站旨在免费分享,内容仅供个人学习、研究或参考使用。若引用了第三方作品,版权归原作者所有。如内容涉及您的权益,请联系我们处理。
内容垂直聚焦
专注技术核心技术栏目,确保每篇文章深度聚焦于实用技能。从代码技巧到架构设计,为用户提供无干扰的纯技术知识沉淀,精准满足专业提升需求。
知识结构清晰
覆盖从开发到部署的全链路。AI、前端、编程、数据库、服务器、建站、系统层层递进,构建清晰学习路径,帮助用户系统化掌握开发与运维所需的核心技术。
深度技术解析
拒绝泛泛而谈,深入技术细节与实践难点。无论是数据库优化还是服务器配置,均结合真实场景与代码示例进行剖析,致力于提供可直接应用于工作的解决方案。
专业领域覆盖
精准对应开发生命周期。从前端界面到后端编程,从数据库操作到服务器运维,形成完整闭环,一站式满足全栈工程师和运维人员的技术需求。
即学即用高效
内容强调实操性,步骤清晰、代码完整。用户可根据教程直接复现和应用于自身项目,显著缩短从学习到实践的距离,快速解决开发中的具体问题。
持续更新保障
专注既定技术方向进行长期、稳定的内容输出。确保各栏目技术文章持续更新迭代,紧跟主流技术发展趋势,为用户提供经久不衰的学习价值。