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/8/8 0:05:12 阅读更多 →
昇腾AI代理实现多号通话自动化

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

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

2026/8/8 0:04:11 阅读更多 →
Java图像处理实战指南

Java图像处理实战指南

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

2026/8/8 0:04:11 阅读更多 →

最新新闻

怎样高效解决文件乱码问题:EncodingChecker专业编码检测工具完整指南

怎样高效解决文件乱码问题:EncodingChecker专业编码检测工具完整指南

怎样高效解决文件乱码问题:EncodingChecker专业编码检测工具完整指南 【免费下载链接】EncodingChecker A GUI tool that allows you to validate the text encoding of one or more files. Modified from https://encodingchecker.codeplex.com/ 项目地址: https…

2026/8/8 1:06:01 阅读更多 →
C语言转义字符\b的底层原理与终端编程实战

C语言转义字符\b的底层原理与终端编程实战

1. 从一次“诡异”的终端输出说起 那天,我在调试一个C语言的小工具,功能很简单,就是打印一个进度条,格式是 [> ] 50% 。为了让进度条在同一行动态更新,我用了经典的 \r 回车符,把光标拉回行首&#…

2026/8/8 1:06:01 阅读更多 →
图解Java内存模型:堆、栈、方法区与常量池实战解析

图解Java内存模型:堆、栈、方法区与常量池实战解析

1. 从一次线上故障说起:为什么必须搞懂Java内存模型 那天下午,系统监控突然报警,一个核心服务的响应时间从几十毫秒飙升到十几秒,紧接着就出现了大量的 java.lang.OutOfMemoryError: Java heap space 错误。团队立刻进入紧急状态…

2026/8/8 1:06:01 阅读更多 →
MATLAB实现2FSK非相干解调:从原理到仿真的完整链路实践

MATLAB实现2FSK非相干解调:从原理到仿真的完整链路实践

1. 项目缘起:为什么从2FSK的非相干解调入手? 在数字通信的入门实践中,2FSK(二进制频移键控)信号的调制与解调是一个绕不开的经典课题。你可能在教科书上看过它的原理框图,公式推导也似乎清晰明了&#xff0…

2026/8/8 1:05:00 阅读更多 →
C语言入门:从翁恺课程到编程环境搭建与核心概念解析

C语言入门:从翁恺课程到编程环境搭建与核心概念解析

1. 项目概述:为什么从翁恺老师的C语言课开始? 如果你正在寻找一个系统、扎实且能真正带你入门的C语言学习起点,那么浙江大学翁恺老师的《C语言程序设计》课程,几乎是一个无需犹豫的选择。这门课在国内外各大慕课平台上的口碑&…

2026/8/8 1:05:00 阅读更多 →
08-目标检测学习路线与模型选型指南(工控/嵌入式/机械臂场景)

08-目标检测学习路线与模型选型指南(工控/嵌入式/机械臂场景)

目标检测学习路线与模型选型指南(工控/嵌入式/机械臂场景) 大家好,我是黒漂技术佬。前三篇把环境、预处理、数据集都聊完了,今天来点宏观的——目标检测这么多模型,到底该学哪个、该用哪个? 这个问题我被问过不下五十次。工控老哥说要稳、嵌入式老哥说要小、机械臂老哥…

2026/8/8 1:05:00 阅读更多 →

日新闻

AI多智能体时代来临,读懂MCP与A2A架构,抢占企业数字化新风口

AI多智能体时代来临,读懂MCP与A2A架构,抢占企业数字化新风口

当下AI应用飞速普及,无数企业下场搭建智能体系统,可落地阶段难题接踵而至:上下文无限堆积频繁爆栈、AI工具调用准确率低下、Token成本居高不下、企业数据权限混乱暗藏安全隐患……很多团队卡在架构搭建环节,空有前沿技术概念&…

2026/8/8 0:00:07 阅读更多 →
PHP二维码生成终极指南:用chillerlan/php-qrcode打造专业级二维码

PHP二维码生成终极指南:用chillerlan/php-qrcode打造专业级二维码

PHP二维码生成终极指南:用chillerlan/php-qrcode打造专业级二维码 【免费下载链接】php-qrcode A PHP QR Code generator and reader with a user-friendly API. 项目地址: https://gitcode.com/gh_mirrors/ph/php-qrcode 在当今数字时代,二维码已…

2026/8/8 0:00:08 阅读更多 →
UniApp微信小程序隐私保护组件开发:从原理到实战

UniApp微信小程序隐私保护组件开发:从原理到实战

1. 项目缘起:为什么我们需要一个隐私保护通用组件?最近在维护一个基于uniapp开发的微信小程序矩阵时,我遇到了一个非常棘手的问题。随着平台对用户隐私保护的要求越来越严格,几乎每一个新版本发布,或者在某些特定机型&…

2026/8/8 0:00:08 阅读更多 →

周新闻

最大流算法详解:从水管网络到Ford-Fulkerson与Dinic实战

最大流算法详解:从水管网络到Ford-Fulkerson与Dinic实战

1. 从水管网络到最大流:一个核心问题的诞生想象一下,你是一个城市供水系统的总工程师。你的城市有多个水源(水库),需要通过一个复杂的地下管道网络,将水输送到各个居民区。每条管道都有其最大通水能力&…

2026/8/6 22:02:27 阅读更多 →
基于Springboot的企业门户网站(源码+LW+调试文档+讲解)

基于Springboot的企业门户网站(源码+LW+调试文档+讲解)

温馨提示:本人主页置顶文章(点我)开头有 CSDN 平台官方提供的学长联系方式的名片! 温馨提示:本人主页置顶文章(点我)开头有 CSDN 平台官方提供的学长联系方式的名片! 温馨提示:本人主页置顶文章(点我)开头有 CSDN 平台…

2026/8/6 22:02:27 阅读更多 →
MATLAB xcorr函数详解:从互相关原理到四大实战应用

MATLAB xcorr函数详解:从互相关原理到四大实战应用

1. 从一次信号“找茬”说起:为什么我们需要互相关几年前,我在处理一组声学传感器数据时遇到了一个棘手的问题。我有两个麦克风记录了一段相同的音频信号,理论上它们接收到的声音波形应该非常相似,只是由于麦克风位置不同&#xff…

2026/8/7 23:24:08 阅读更多 →

月新闻

免费解锁百度网盘SVIP加速:macOS用户必备的下载提速终极指南

免费解锁百度网盘SVIP加速:macOS用户必备的下载提速终极指南

免费解锁百度网盘SVIP加速:macOS用户必备的下载提速终极指南 【免费下载链接】BaiduNetdiskPlugin-macOS For macOS.百度网盘 破解SVIP、下载速度限制~ 项目地址: https://gitcode.com/gh_mirrors/ba/BaiduNetdiskPlugin-macOS 还在为百度网盘macOS版的龟速下…

2026/8/7 17:02:37 阅读更多 →
终极ncmdump指南:3分钟实现网易云NCM音乐解密与格式转换

终极ncmdump指南:3分钟实现网易云NCM音乐解密与格式转换

终极ncmdump指南:3分钟实现网易云NCM音乐解密与格式转换 【免费下载链接】ncmdump 项目地址: https://gitcode.com/gh_mirrors/ncmd/ncmdump 还在为网易云音乐下载的NCM格式文件无法在其他播放器播放而烦恼吗?ncmdump解密工具帮你轻松解决这个困…

2026/8/7 23:54:54 阅读更多 →
HarmonyOS 应用开发《掌上英语》第81篇: 智能体卡片:为英语学习 App 打造桌面级学习助手

HarmonyOS 应用开发《掌上英语》第81篇: 智能体卡片:为英语学习 App 打造桌面级学习助手

AgentCard 智能体卡片:为英语学习 App 打造桌面级学习助手适用平台:HarmonyOS 7.0 (API 26 Beta)一、引言 HarmonyOS 7.0(API 26 Beta)新增了 AgentCard 智能体卡片能力,这是继 HMAF(鸿蒙智能体框架&#x…

2026/8/7 17:02:36 阅读更多 →