FastAPI 写出第一个任务 API 路由、参数校验与自动文档
下午临时接到一个需求产品只留下一句话做一个能新增、查看和完成任务的接口。要是从路由、校验、接口文档全都手写半天大概就没了。FastAPI 有意思的地方在于Python 类型标注已经把这些信息写了一半。配套代码已经放在 fastapi-task-api文章中的完整实现以main分支为准。先把服务跑起来这个系列会做一个任务管理 API。第一篇故意不接数据库数据放在内存里。这样各位能先看清一件事HTTP 请求怎样变成 Python 函数调用再谈 PostgreSQL、Redis 这些后面的东西。uv init fastapi-task-api uv add fastapiuvicorn[standard]uv run uvicorn main:app--reload新建main.py先只保留健康检查。浏览器打开http://127.0.0.1:8000/docsSwagger UI 已经出现了。自动文档不是额外配置它来自路由、参数和模型的类型信息。fromfastapiimportFastAPI appFastAPI(titleTask API)app.get(/health)asyncdefhealth()-dict[str,str]:return{status:ok}# 给容器和负载均衡做健康检查路由不是把函数挂到 URL 上就结束了任务 API 至少需要创建、列表、详情、修改和删除五个动作。HTTP 方法表达动作URL 表达资源。把动词塞进 URL例如/createTask不是不能用只是客户端以后很难猜规则。HTTP 请求路由匹配Pydantic 校验Python 函数JSON 响应FastAPI 在函数调用前完成了中间两步。路径参数、查询参数和 JSON 请求体来自不同位置写法却很接近。fromenumimportStrEnumfrompydanticimportBaseModel,FieldclassTaskStatus(StrEnum):TODOtodoDONEdoneclassTaskCreate(BaseModel):title:strField(min_length1,max_length200)description:str|NoneField(defaultNone,max_length5000)classTaskRead(TaskCreate):id:intstatus:TaskStatusTaskCreate只允许客户端传入可写字段TaskRead才带上服务端生成的id和状态。请求模型与响应模型分开是 API 以后不容易失控的第一道门。做一组真的能调用的 CRUD内存列表不适合生产却很适合把注意力放在接口契约上。下面的代码省去了并发控制单进程演示足够。fromfastapiimportHTTPException,Query,status tasks:list[TaskRead][]app.post(/tasks,response_modelTaskRead,status_codestatus.HTTP_201_CREATED)asyncdefcreate_task(payload:TaskCreate)-TaskRead:taskTaskRead(idlen(tasks)1,statusTaskStatus.TODO,**payload.model_dump())tasks.append(task)returntaskapp.get(/tasks,response_modellist[TaskRead])asyncdeflist_tasks(skip:intQuery(0,ge0),limit:intQuery(20,ge1,le100)):returntasks[skip:skiplimit]# 查询参数天然支持分页app.get(/tasks/{task_id},response_modelTaskRead)asyncdefread_task(task_id:int)-TaskRead:tasknext((itemforitemintasksifitem.idtask_id),None)iftaskisNone:raiseHTTPException(status_code404,detailTask not found)returntask试着提交一个空标题响应会是422里面带有字段路径和失败原因。这个错误不是我们手写出来的。Pydantic 在函数执行前发现min_length不满足于是请求不会碰到业务代码。参数校验解决的是边界问题很多项目一开始会把title当普通字符串收下再到数据库报错时回头补校验。这个路径很绕。输入靠近接口边界时就应该被拒绝后面的服务函数才不必反复猜测数据能不能用。状态筛选同样可以交给类型系统。枚举值以外的字符串不会进入函数。app.get(/tasks)asyncdeflist_by_status(status:TaskStatus|NoneNone)-list[TaskRead]:ifstatusisNone:returntasksreturn[taskfortaskintasksiftask.statusstatus]这里还有一个容易踩的坑。路径/tasks/{task_id}和静态路径/tasks/search同时存在时静态路径要先注册。不然search会被当成task_id然后得到很迷惑的校验错误。自动文档为什么值得认真对待/docs不只是演示页。它同时给前端、测试人员和未来的自己看。模型字段的描述、状态码、响应模型都会进入 OpenAPI 定义客户端 SDK 或接口平台也能据此生成调用代码。先把接口边界写清楚后面的数据库和鉴权才有地方落脚。到这里我们已经有一个能创建和查询任务的 API。它离上线还很远重启就丢数据多人使用也没有边界。但路由、模型、校验和文档这四根骨架已经立住了。下一篇把list换成 PostgreSQL 查询任务才真正留下来。本篇收口FastAPI 从函数签名推导参数校验和 OpenAPI 文档Pydantic 模型把可写数据和返回数据分开422用来报告不合格输入404用来报告不存在的资源内存 CRUD 只负责讲清接口形状持久化交给下一篇

相关新闻

UE5 GAS实战:GameplayEffect实现RPG药水效果(治疗、回蓝、Buff)

UE5 GAS实战:GameplayEffect实现RPG药水效果(治疗、回蓝、Buff)

1. 项目概述:从一瓶药水开始,理解GAS的核心玩法 在UE5里做RPG,给角色加血加蓝、上Buff,听起来是基础得不能再基础的需求。但当你真正上手,想把一瓶“治疗药水”的效果做扎实时,往往会发现事情没那么简单。是…

2026/10/26 10:49:15 阅读更多 →
昇腾AI代理实现多号通话自动化

昇腾AI代理实现多号通话自动化

基于昇腾(Ascend)硬件与AtomGit AI社区的开源生态,结合AI Agent技术,可以实现一个模拟“通话重复使用机号复制”功能的安卓手机应用原型。其核心是利用AI Agent进行意图理解、任务编排和自动化操作,模拟或管理多号码的…

2026/10/25 7:12:24 阅读更多 →
Java图像处理实战指南

Java图像处理实战指南

要执行这些 Java AWT 图像处理程序,你需要将它们分别保存为独立的 .java 文件,并使用 javac 编译,然后使用 java 运行。以下是每个程序的核心执行步骤、依赖关系和要点。 通用执行步骤 保存文件:将每个 listing 的代码复制到文本…

2026/10/26 14:36:29 阅读更多 →

最新新闻

Electron桌面应用开发实战:从环境搭建到打包发布全流程

Electron桌面应用开发实战:从环境搭建到打包发布全流程

做前端这些年,我大部分时间都在跟浏览器标签页打交道,直到第一次把桌面应用跑起来,才发现原来自己一直被限制在地址栏和刷新按钮围起来的框框里。Electron这个词,最开始是在某段时间频繁出现在同事的讨论里,一个用HTML…

2026/10/26 12:00:21 阅读更多 →
滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

滑盖智能锁T109深度解析:结构原理、安装调试与故障排查

简介:亚太天能T109滑盖智能锁产品说明书是一份PDF格式的官方技术文档,主要面向智能锁安装人员、终端用户及售后维护者,帮助快速掌握产品安装、配置与常见故障处理。全包仅1个PDF文件,大小4.37MB,内容结构清晰&#xff…

2026/10/25 22:36:10 阅读更多 →
PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

PMSM弱磁控制原理与Simulink建模:高速AGV驱动系统设计指南

上个月我在调试一台高速AGV的驱动系统,整车要求空载跑到8m/s,电机转速已经拉到额定点,驱动器的输出电压也顶到了母线电压极限附近。再往上踩速度指令,转速纹丝不动,三相电流反而开始震荡。那会儿我的第一反应就是&…

2026/10/26 4:52:12 阅读更多 →
C++核心知识点:从内存管理到STL的实战指南

C++核心知识点:从内存管理到STL的实战指南

C 这门语言我前前后后折腾了十几年,用它写过嵌入式驱动、做过游戏服务端,也搭过基础组件库。每次看到新人一头扎进"C 核心知识点"这个搜索词,我其实挺感慨的——这门语言的难点从来不是语法多,而是知识点之间的耦合太深…

2026/10/26 12:00:21 阅读更多 →
T109滑盖智能锁怎么装?安装调试与故障排查全攻略

T109滑盖智能锁怎么装?安装调试与故障排查全攻略

简介:亚太天能T109滑盖智能锁产品说明书以PDF格式发布,适合智能锁用户、安装人员与售后维修人员阅读。内容围绕T109系列指纹密码刷卡锁展开,先介绍前面板、后面板、锁体、机械钥匙、电池盒盖等部件名称与功能,再给出完整安装步骤&…

2026/10/26 5:00:37 阅读更多 →
LLM知识降熵:从信息垄断到理解权下放

LLM知识降熵:从信息垄断到理解权下放

你有没有过这种经历:翻开源码注释、论文摘要或者一份专业报告,每个字都认识,连在一起却像天书。想找人聊聊,身边要么没人懂,要么懂的懒得跟你解释。后来我试着把同一段内容丢给一个大语言模型,几秒钟之后&a…

2026/10/26 3:16:46 阅读更多 →

日新闻

周新闻

月新闻

我发现了一个新思路:用 Remotion + Claude Code 像写代码一样自动化生成短视频

我发现了一个新思路:用 Remotion + Claude Code 像写代码一样自动化生成短视频

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/26 12:00:19 阅读更多 →
Windows下 Codex 中 Chrome 和 Computer Use 插件不可用问题排查及解决参考方式:TaoToken 统一 Key 配置与验证

Windows下 Codex 中 Chrome 和 Computer Use 插件不可用问题排查及解决参考方式:TaoToken 统一 Key 配置与验证

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/25 13:21:54 阅读更多 →
黑夜航拍船只数据集训练YOLOV5模型全流程解析

黑夜航拍船只数据集训练YOLOV5模型全流程解析

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/26 8:34:37 阅读更多 →