0

0

Python怎么开发RESTful API_Flask-RESTful或FastAPI实战

P粉602998670

P粉602998670

发布时间:2026-03-11 18:49:03

|

571人浏览过

|

来源于php中文网

原创

新项目首选fastapi:原生异步、自动openapi文档、强类型校验;已有flask项目可先用flask-restx过渡;务必使用response_model声明响应结构,路径参数须用path(...)标注,开发时uvicorn需加--reload等参数。

python怎么开发restful api_flask-restful或fastapi实战

用 FastAPI 还是 Flask-RESTful?看这三点就定下来

FastAPI 是当前 Python 开发 RESTful API 的事实首选,除非你正在维护一个老 Flask 项目且不打算升级。Flask-RESTful 已基本停止更新,官方文档都标记为“legacy”,而 FastAPI 原生支持异步、自动 OpenAPI 文档、强类型校验——这些不是“锦上添花”,而是省掉大量手动写验证逻辑和文档同步的刚需。

常见错误现象:TypeError: object of type 'dict' is not JSON serializable 在 Flask-RESTful 里常因返回非标准类型(如 datetime)触发;FastAPI 遇到同样情况会直接报错并提示具体字段,定位更快。

  • 新项目无脑选 FastAPI:开发效率高、出错反馈准、异步支持开箱即用
  • 已有 Flask 项目想渐进改造:先用 flask-restx(比 Flask-RESTful 更现代),再逐步迁移到 FastAPI
  • 团队对 asyncio 完全没经验且接口全是同步 DB 查询:可暂缓用 FastAPI 的 async def,改用普通 def 路由,它依然能跑

FastAPI 路由定义时,response_model 不是可选项

很多人只写 @app.get("/users") 就返回 dict,结果前端收到字段名拼错、多出调试字段、时间格式混乱——根本原因是没声明响应结构。FastAPI 的 response_model 不只是生成文档,它真会做序列化裁剪和类型转换。

使用场景:返回用户列表时,数据库模型含 password_hashcreated_atdatetime 类型),但 API 只该暴露 idnamejoined_date(ISO 格式字符串)。

立即学习Python免费学习笔记(深入)”;

银河易创
银河易创

一站式AIGC创作平台,集成GPT-3.5、GPT-4、文心一言等对话模型、Midjourney、DallE等绘画工具、AI音乐、AI视频和AI PPT等功能!

下载
  • 必须用 Pydantic 模型定义 response_model,不能用 dict 或 dataclass(除非显式配置 pydantic_config
  • datetime 字段在模型中声明为 datetime 类型,FastAPI 自动转成 ISO 格式字符串;若声明为 str,它反而会拒绝接收 datetime 实例
  • 漏写 response_model 导致返回数据包含内部字段(比如 SQLAlchemy 的 _sa_instance_state),这是线上最常被前端吐槽的“字段污染”问题
from pydantic import BaseModel
from datetime import datetime
<p>class UserOut(BaseModel):
id: int
name: str
joined_date: datetime  # 自动转成 "2024-05-20T08:30:00"

路径参数、查询参数、请求体混用时,顺序和类型注解决定行为

FastAPI 不靠装饰器参数顺序或关键字来区分参数来源,而是完全依赖函数签名里的类型注解 + 特殊类(如 PathQueryBody)。写错一个注解,参数就进错地方,且可能静默失败。

常见错误现象:user_id 明明是 URL 路径参数,却在函数里写成 def read_user(user_id: int) ——FastAPI 默认把它当查询参数,导致 /users/123 返回 404,而 /users?user_id=123 才生效。

  • 路径参数必须用 Path(...) 显式标注(... 表示必填),哪怕类型已写 int
  • 多个查询参数想设默认值?别写 q: str = None,改用 q: str = Query(None),否则 FastAPI 无法识别它是查询参数
  • POST 请求带 JSON body 又要收查询参数?函数签名顺序无所谓,但 body 参数必须是最后一个,且类型不能是基础类型(如 strint),否则 FastAPI 会把它当查询参数解析

本地调试时,别信 uvicorn.run() 的默认配置

直接写 uvicorn.run("main:app") 启动,代码改了不会热重载,端口冲突也不报具体错,连 Ctrl+C 有时都杀不干净进程——这不是 FastAPI 的问题,是 Uvicorn 默认配置太“生产向”。

性能影响:默认单 worker,压测时吞吐卡在 1k QPS 下;开发期却要反复手动重启,实际拖慢的是人效。

  • 开发务必加 --reload--reload-dir(指定监控目录,避免扫描整个虚拟环境)
  • 端口被占?加 --port 8001,别等报错后去查哪个进程占着 8000
  • 想看每条请求的耗时和状态码?加 --log-level debug,比自己写中间件快得多
  • 命令示例:uvicorn main:app --reload --reload-dir ./app --port 8001 --log-level debug

复杂点在于:reload 机制依赖文件系统事件,在 Docker for Mac 或某些 NFS 卷上可能失效,这时得换 --reload-delay 或改用 watchfiles。但那是另一层问题了。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python Flask框架
Python Flask框架

本专题专注于 Python 轻量级 Web 框架 Flask 的学习与实战,内容涵盖路由与视图、模板渲染、表单处理、数据库集成、用户认证以及RESTful API 开发。通过博客系统、任务管理工具与微服务接口等项目实战,帮助学员掌握 Flask 在快速构建小型到中型 Web 应用中的核心技能。

104

2025.08.25

Python Flask Web框架与API开发
Python Flask Web框架与API开发

本专题系统介绍 Python Flask Web框架的基础与进阶应用,包括Flask路由、请求与响应、模板渲染、表单处理、安全性加固、数据库集成(SQLAlchemy)、以及使用Flask构建 RESTful API 服务。通过多个实战项目,帮助学习者掌握使用 Flask 开发高效、可扩展的 Web 应用与 API。

81

2025.12.15

PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

179

2025.11.26

什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

182

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

226

2025.12.18

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

455

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.9万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号