1. FastAPI待办事项API开发全景指南作为Python生态中增长最快的Web框架之一FastAPI凭借其卓越的性能和开发者体验已经成为构建现代API的首选工具。今天我将通过一个完整的待办事项(To-Do)API开发案例带你掌握FastAPI的核心开发模式。这个项目虽然看似简单但完整覆盖了路由定义、请求处理、数据校验等API开发的关键环节。我曾在一个电商后台系统的开发中使用类似的架构仅用3天就完成了原本需要1周时间的API开发工作。FastAPI的自动文档生成和类型提示确实能显著提升开发效率。下面让我们从零开始构建这个具有完整CRUD功能的待办事项API。2. 项目结构与基础配置2.1 初始化项目环境首先创建项目目录并初始化虚拟环境mkdir fastapi-todo cd fastapi-todo python -m venv venv source venv/bin/activate # Linux/Mac venv\Scripts\activate # Windows安装必要的依赖包pip install fastapi uvicorn pydantic提示建议使用Python 3.7版本以获得最佳的FastAPI体验。如果使用PyCharm等IDE注意在项目设置中正确配置Python解释器路径。2.2 项目目录结构设计一个良好的项目结构能显著提升代码可维护性。参考我多个FastAPI项目的经验推荐如下结构fastapi-todo/ ├── app/ │ ├── __init__.py │ ├── main.py │ ├── models/ │ │ └── todo.py │ ├── routes/ │ │ └── todos.py │ └── db/ │ └── fake_db.py ├── tests/ └── requirements.txt这种结构将不同功能的代码模块化分离特别适合中大型项目。对于初学者来说可以暂时忽略tests目录但保持这种习惯对日后项目扩展很有帮助。3. 数据模型与路由定义3.1 使用Pydantic定义数据模型在app/models/todo.py中定义我们的待办事项模型from datetime import datetime from typing import List, Optional from pydantic import BaseModel class TodoBase(BaseModel): title: str description: Optional[str] None tags: List[str] [] due_date: Optional[datetime] None class TodoCreate(TodoBase): pass class Todo(TodoBase): id: int completed: bool False class Config: orm_mode True这里我们定义了三个模型类TodoBase: 基础模型包含所有共享字段TodoCreate: 专门用于创建操作的模型Todo: 完整模型包含ID和完成状态经验分享Pydantic的模型继承机制非常实用。我在实际项目中通常会为不同操作定义专门的模型这样可以在不同场景下精确控制字段。3.2 实现内存数据库为了简化示例我们先使用内存存储数据。在app/db/fake_db.py中from typing import Dict from app.models.todo import Todo todos: Dict[int, Todo] {} current_id 0 def get_next_id() - int: global current_id current_id 1 return current_id这种内存数据库虽然简单但足够我们演示核心功能。在生产环境中你可以轻松替换为真实的数据库连接。4. 路由实现详解4.1 初始化路由在app/routes/todos.py中创建路由实例from fastapi import APIRouter, HTTPException, status from app.models.todo import Todo, TodoCreate from app.db.fake_db import todos, get_next_id router APIRouter( prefix/todos, tags[todos] )APIRouter是FastAPI组织路由的核心工具。prefix参数会自动为所有路由添加前缀tags用于OpenAPI文档分组。4.2 创建(Create)路由实现创建待办事项的POST路由router.post(/, response_modelTodo, status_codestatus.HTTP_201_CREATED) async def create_todo(todo: TodoCreate) - Todo: todo_id get_next_id() db_todo Todo(idtodo_id, **todo.dict()) todos[todo_id] db_todo return db_todo这个路由接收TodoCreate类型的请求体生成新ID并创建Todo对象存储到内存数据库返回创建的对象注意我们明确设置了201状态码这是RESTful API中创建资源的标准响应。4.3 读取(Read)路由实现获取单个和所有待办事项的路由router.get(/, response_modellist[Todo]) async def read_todos(completed: bool None) - list[Todo]: if completed is None: return list(todos.values()) return [todo for todo in todos.values() if todo.completed completed] router.get(/{todo_id}, response_modelTodo) async def read_todo(todo_id: int) - Todo: if todo_id not in todos: raise HTTPException( status_codestatus.HTTP_404_NOT_FOUND, detailTodo not found ) return todos[todo_id]第一个路由支持可选过滤参数第二个路由在找不到资源时返回404错误。4.4 更新(Update)路由实现更新待办事项的PUT路由router.put(/{todo_id}, response_modelTodo) async def update_todo(todo_id: int, todo: TodoCreate) - Todo: if todo_id not in todos: raise HTTPException( status_codestatus.HTTP_404_NOT_FOUND, detailTodo not found ) db_todo Todo(idtodo_id, **todo.dict()) todos[todo_id] db_todo return db_todo4.5 删除(Delete)路由实现删除待办事项的DELETE路由router.delete(/{todo_id}, status_codestatus.HTTP_204_NO_CONTENT) async def delete_todo(todo_id: int) - None: if todo_id not in todos: raise HTTPException( status_codestatus.HTTP_404_NOT_FOUND, detailTodo not found ) del todos[todo_id] return None删除操作通常返回204状态码和空响应体。5. 应用集成与测试5.1 主应用集成在app/main.py中集成所有组件from fastapi import FastAPI from app.routes import todos app FastAPI() app.include_router(todos.router) app.get(/) async def root(): return {message: Todo API Service}5.2 启动应用使用UVicorn启动服务uvicorn app.main:app --reload--reload参数启用自动重载非常适合开发环境。5.3 测试API使用curl测试各个端点创建待办事项curl -X POST http://127.0.0.1:8000/todos/ \ -H Content-Type: application/json \ -d {title:Learn FastAPI,description:Study routing system,tags:[learning,python]}获取所有待办事项curl http://127.0.0.1:8000/todos/更新待办事项curl -X PUT http://127.0.0.1:8000/todos/1 \ -H Content-Type: application/json \ -d {title:Master FastAPI,description:Deep dive into routing,tags:[expert,python]}删除待办事项curl -X DELETE http://127.0.0.1:8000/todos/16. 高级技巧与最佳实践6.1 路由组织技巧对于大型项目我推荐按功能模块组织路由。例如routes/ ├── auth/ ├── todos/ └── users/每个模块有自己的路由文件然后在主应用中统一引入。6.2 错误处理优化可以创建自定义异常处理器统一处理特定类型的错误from fastapi import FastAPI, Request from fastapi.responses import JSONResponse app FastAPI() app.exception_handler(ValueError) async def value_error_handler(request: Request, exc: ValueError): return JSONResponse( status_code400, content{message: str(exc)}, )6.3 性能优化建议对于频繁读取的路由考虑添加缓存from fastapi_cache import FastAPICache from fastapi_cache.backends.redis import RedisBackend from fastapi_cache.decorator import cache app.on_event(startup) async def startup(): FastAPICache.init(RedisBackend(redis://localhost)) router.get(/) cache(expire60) async def read_todos(): ...使用异步数据库驱动如asyncpg或aiomysql提高IO密集型操作性能7. 项目扩展方向7.1 数据库集成将内存数据库替换为真实数据库非常简单。以SQLAlchemy为例安装依赖pip install sqlalchemy databases[postgresql]配置数据库连接from sqlalchemy import create_engine from sqlalchemy.ext.declarative import declarative_base DATABASE_URL postgresql://user:passwordlocalhost/dbname engine create_engine(DATABASE_URL) Base declarative_base()7.2 用户认证添加JWT认证保护APIfrom fastapi.security import OAuth2PasswordBearer oauth2_scheme OAuth2PasswordBearer(tokenUrltoken) router.get(/protected) async def protected_route(token: str Depends(oauth2_scheme)): return {message: This is protected data}7.3 部署准备创建生产级DockerfileFROM python:3.9-slim WORKDIR /app COPY requirements.txt . RUN pip install --no-cache-dir -r requirements.txt COPY . . CMD [uvicorn, app.main:app, --host, 0.0.0.0, --port, 80]使用Gunicorn作为生产服务器gunicorn -w 4 -k uvicorn.workers.UvicornWorker app.main:app通过这个完整的待办事项API项目我们实践了FastAPI的核心功能。从简单的内存存储开始你可以轻松扩展为完整的生产级应用。FastAPI的优雅设计和强大功能确实能让我们在Python Web开发中事半功倍。
企业数字化 ERP 产品动态
相关推荐
React组件重新渲染机制与性能优化实践 1. React 重新渲染机制解析在React开发中,组件重新渲染是一个核心概念,也是性能优化的关键切入点。当组件的props或state发生变化时,React会重新调用组件的render方法生成新的虚拟DOM,然后与旧的虚拟DOM进行对比(diff算… · 2026/8/8 4:03:45
人形机器人日常训练实战:从ROS部署到步态调优与强化学习集成 1. 从“开箱即玩”到“日常训练”:人形机器人进阶之路如果你刚拿到一台Unitree G1或H1这样的人形机器人,兴奋地让它走了几步、挥了挥手,拍完视频发完朋友圈之后,接下来该做什么?这可能是很多机器人爱好者、开发者甚至研… · 2026/7/25 6:45:49
深度解析ExplorerPatcher架构设计:3大核心技术实现原理与Windows界面定制优化 深度解析ExplorerPatcher架构设计:3大核心技术实现原理与Windows界面定制优化 【免费下载链接】ExplorerPatcher This project aims to enhance the working environment on Windows 项目地址: https://gitcode.com/GitHub_Trending/ex/ExplorerPatcher
Expl… · 2026/9/20 18:29:07
电工证能不能购买 电子证书怎么查 低学历也能考吗 电工证能不能购买 电子证书怎么查 低学历也能考吗 学历不高怕报不上名,你是不是也担心自己因为文化水平不够,连电工证都考不了?别慌,现在的电工证 不能直接购买 ,但只要你符合报考条件,完全可以通过正规渠道报考并拿到 电子证书… · 2026/11/19 1:51:34
学校培训中级电工证官方回应来了,别再被中介骗钱了 学校培训中级电工证官方回应来了,别再被中介骗钱了 你是不是也在担心, 不知道去哪报名怕被中介坑 ?别急, 官方回应 来了,今天就来聊聊 学校培训中级电工证… · 2026/11/19 1:51:34
电工证低压高压哪个好在哪考不走弯路 电工证低压高压哪个好在哪考不走弯路 怕考不过白交培训费?你不是一个人。现在越来越多的从业者在考虑考电工证,尤其是低压和高压电工证,到底哪个更划算、更有前途,成了大家心中的疑问。很多人不知道 在哪考… · 2026/11/19 1:51:34
兴义电工证复审考试保姆级教程:怕考不过白交培训费?这篇全搞定 兴义电工证复审考试保姆级教程:怕考不过白交培训费?这篇全搞定 怕考不过白交培训费?别慌,兴义电工证复审考试其实没你想象的那么难。只要掌握对方法,考过只是时间问题。今天这篇保姆级教程,从备考重点到考试技巧,帮你一步步稳过复审,不再为钱浪费。… · 2026/11/19 1:50:34
长春初级电工证怎么考?通过率揭秘全在这里 长春初级电工证怎么考?通过率揭秘全在这里 之前考的证在外省能不能转过来?这几乎是每个想从事电工工作的人都会问的问题。特别是那些在外地打拼多年、手里握着一张“外地电工证”的人,到了长春想继续干这一行,第一反应就是“我的证能用吗?”。今天我们就… · 2026/11/18 8:19:55
国内电工证报考条件与考试时间 低压电工证怎么考?学历不高也能报名,官方报名入口全在这 你是不是经常听说“电工证是入行门槛”,但又担心自己学历不够、经验不足,根本报不了名?别急,今天就带你从零了解【国内电工证】的报考流程、考试内容,还有怎么在 官方报名入口… · 2026/11/18 8:19:53
电工作业时如何断电?电子证书到底能不能全国通用? 电工作业时如何断电?电子证书到底能不能全国通用? 实操考试心里没底怕挂科,特别是电工作业时如何断电这一操作,不仅关系到你能不能拿到证书,更关系到以后能不能顺利上岗。很多人觉得这不过就是“断个电”,但其实这里面的门道可不少,稍有不慎就可能出错… · 2026/11/18 14:38:14
姑苏区哪里考电工证好考前押题怎么找 姑苏区哪里考电工证好考前押题怎么找 工地太忙根本没时间复习考试,电工证考前还总找不到靠谱的 考前押题 资源,真让人头疼。如果你也是在苏州姑苏区从事建筑或电力行业的,那这些建议你一定要看完。 为什么姑苏区考电工证的人这么多?… · 2026/11/19 0:00:12
罗定能考电工证吗?外省证转过来流程全解析+郑州报考避坑指南 罗定能考电工证吗?外省证转过来流程全解析+郑州报考避坑指南 之前考的证在外省能不能转过来?这几乎是每个特种作业证书持有者都会遇到的问题,特别是像你这样已经在外地工作多年,想回老家罗定发展或者重新规划职业路径的人。别急,今天就给你一条清晰的路… · 2026/11/19 0:00:12
罗定能考电工证吗 电工证含金量到底有多少? 罗定能考电工证吗 电工证含金量到底有多少? 之前考的证在外省能不能转过来,这几乎是每个准备考电工证的朋友最先想到的问题。特别是在罗定这样的地方,很多人的电工证都是在外地考的,现在想在当地继续使用,但不知道怎么办。实际上,电工证的 含金量… · 2026/11/19 0:00:12
双极步进电机控制实战:DRV8818PWPR与PIC18F86K22驱动调试 /* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views … · 2026/11/17 21:47:42
STM32F207ZG + DRV8818PWPR 步进电机驱动实战解析 /* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views … · 2026/11/17 21:47:42
DRV8818PWPR+dsPIC30F4013工业级双极步进电机控制方案 /* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views … · 2026/11/19 0:22:38