Python从入门到精通1：FastAPI

惊雷无声  金牌会员 | 2025-3-11 16:03:33 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 990|帖子 990|积分 2970

引言

在现代 Web 开发中，API 是前后端分离架构的核心。FastAPI 依附其高性能、简便的语法和主动文档生成功能，成为 Python 开发者的首选框架。本文将从零开始，具体解说 FastAPI 的核心概念、安装设置、路由计划、请求处置惩罚以及现实应用案例，助你快速掌握这一高效工具。
一、FastAPI 概述与安装

1.1 什么是 FastAPI？

FastAPI 是一个基于 Python 3.8+ 的现代 Web 框架，专注于构建高性能 RESTful API。其核心特点包罗：


  • 基于 Starlette 和 Pydantic：提供异步支持和严格的数据验证。
  • 主动生成 API 文档：内置 Swagger UI 和 ReDoc，开发者无需手动维护文档。
  • 类型提示（Type Hints）：利用 Python 的类型系统实现输入参数验证和代码提示。
1.2 FastAPI 的上风

特性说明高性能异步处置惩罚本领（ASGI）支持高并发，性能媲美 Node.js 和 Go。开发效率高通过类型提示和主动文档生成，减少代码冗余和调试时间。生态完满可无缝集成 SQLAlchemy、OAuth2、JWT 等常用库。 1.3 安装与情况设置及第一个FastApi应用

1.3.1、安装与情况设置

  1. 步骤 1：安装依赖库
  2. pip install fastapi # FastAPI 依赖 Python 3.8 及更⾼版本
  3. 步骤 1：安装uvicorn服务器
  4. pip install "uvicorn[standard]"  # 安装 ASGI 服务器
复制代码
 


1.3.2、第一个FastApi应用

创建 test_one.py：
  1. from fastapi import FastAPI # 导⼊FastAPI，⽤于定义API
  3. app = FastAPI() # 创建FastAPI实例
  5. # http请求方式类型：get、post、put、update、delete
  6. # 浏览器默认访问的是get类型，如果使用其他形式访问
  7. # 出现405的提示（请求的方式不匹配）
  9. # 不带参数的访问形式：
  10. # 访问地址：http://127.0.0.1:8000
  11. @app.get("/")
  12. async def test_one():
  13.     return {"message": "My first fastapi project"}
  15. # 带一个参数的时候的访问形式：
  16. # 访问地址：http://127.0.0.1:8000/hello/小宁
  17. @app.get("/hello/{name}")
  18. async def hello(name: str):
  19.     return {"hello": f"fastapi {name}"}
  21. # 带一个参数的时候的访问形式：
  22. # 访问地址：http://127.0.0.1:8000/my/小宁,21/长沙
  23. @app.get("/my/{name},{age}/{addr}")
  24. async def test_one(name: str, age: int, addr: str):
  25.     return {"name": name, "age": age, "addr": addr}
复制代码
启动uvicorn服务器：

  1. # 在Terminal中输入：
  2. # 语法：uvicorn 文件的相对路径：实例名 --reload
  3. # reload：表示热启动，后端代码改变时，前端页面也会随之改变
  4. uvicorn csdn.test_one:app --reload
复制代码
运行结果：




留意事项：
1、传入参数的时候不能多传，也不能少传。
2、传入的参数一定要满意自己设置的http网址的层级格式。
3、传入的参数要满意函数设置的参数类型。
二、快速入门案例分析

2.1、union的可选参数

 创建 test_two.py：
  1. from typing import Union  # 导⼊Union, ⽤于定义可选类型
  2. from fastapi import FastAPI # 导⼊FastAPI,⽤于构建RESTful API
  4. app = FastAPI()# 创建FastAPI实例
  6. # 访问地址：http://127.0.0.1:8000/items/100？q=小宁
  7. @app.get("/items/{item_id}")
  8. # 定义路由,访问根路径调⽤read_item函数，传⼊item_id参数，并返回该参数对应的数据
  9. # q: Union[str, None] = None ⽤于定义q的可选类型为str或int或None
  10. # 如果http没有传入参数时候，默认为None，避免用户没传入参数，网页就跑不出来的情况
  11. async def  read_item(item_id: int, q: Union[str,int, None] = None):
  12.      return {"item_id": item_id, "q": q}
复制代码
代码分析


  • 路径参数：{item_id} 动态匹配 URL 中的值，主动转换为整数类型。
  • 查询参数：q 通过 Union[str, None] 声明为可选参数。
  • 主动验证：若传入非整数 item_id，FastAPI 返回 HTTP 422 错误。
启动uvicorn服务器：
  1. uvicorn csdn.test_two:app --reload
复制代码

运行结果： 

2.2、uvicorn.run和pydantic类联合Apifox

在前面的课堂案例中，我们启动服务器都要打开终端Timinal中输入启动服务器的语句，那么每次启动都要输出启动的语句，那就很贫苦了，有没有什么办法可以要启动服务器和和之前一样只要点击运行就能够启动呢？以是我们接下来就会讲到uvicorn.run启动服务器。
在前面的内容我们讲过，欣赏器默认的请求方式是get,那么假如我们的http请求方式是post等其他类型的时候怎么办呢，那么就需要利用Apifox软件了，这个各人可以直接官网直接下载。
创建 test_three.py：
  
  1. from fastapi import FastAPI # 引⼊FastAPI类,⽤于创建⼀个应⽤
  2. import uvicorn  # 引⼊uvicorn,⽤于启动服务
  3. from typing import Union  #引⼊Union类，⽤于类型注解
  4. from pydantic import BaseModel # 引⼊pydantic类，⽤于定义数据结构
  6. app = FastAPI() # 创建⼀个应⽤,app是⼀个FastAPI实例
  8. class Item(BaseModel):# 定义⼀个Item类，继承⾃BaseModel，⽤于定义请求体中的数据结构
  9.     # 定义⼀个name属性，类型为str
  10.     name: str
  11.     # 定义⼀个price属性，类型为float
  12.     price: float
  13.     # 定义⼀个is_offer属性，类型为Union[bool, None]，默认为None
  14.     is_offer:Union[bool, None] = None
  16. @app.get("/") # 装饰器，表示定义⼀个根路径的get请求
  17. # 定义⼀个根路径的get请求,返回⼀个字典,键值分别为Hello和World
  18. # async 表示异步请求,可以提⾼性能
  19. # 测试访问：http://127.0.0.1:8000/
  20. async def read_root():
  21.      return {"Hello": "World"}
  23. @app.get("/items/{item_id}")
  24. # 定义⼀个路径参数为item_id的get请求,返回⼀个字典,键值分别为item_id和q
  25. # Union[str, None] 表示q可以为str类型或者None类型，默认为None
  26. # 测试访问：http://127.0.0.1:8000/items/3?q=abc
  27. async def read_item(item_id: int, q: Union[str, None] = None):
  28.     return {"item_id": item_id, "q": q}
  30. @app.put("/items/{item_id}")
  31. # 测试访问：http://127.0.0.1:8000/items/3
  32. async def update_item(item_id: int, item:Item):
  33. # 定义⼀个路径参数为item_id的put请求,返回⼀个字典,键值分别为item_name和item_id
  34.      return {"item_name": item.name, "item_id": item_id,"item_price": item.price,"is_offer": item.is_offer}
  35. # Item类类型传参数的时候要使用apidox中的body中的json格式（字典格式）
  38. if __name__ == "__main__":
  39.      # 启停⽅式：
  40.      # 1.⽅式1指令式：
  41.      # 服务器启动指令 uvicorn main:app --reload
  42.      # fastDemo1:app 表示main.py⽂件中的app实例
  43.      # 服务器停⽌指令 ctrl+c
  44.      # 2.⽅式2界⾯式：
  45.      # ⿏标右键启动----》run main.py
  46.      # 界⾯右上⻆的停⽌按钮
  47.      # 启动服务,host指定主机地址,port指定端⼝号,reload=True表示当代码发⽣变化时,⾃动重启服务
  48.      # main:app---- 表示main.py⽂件中的app实例
  49.      uvicorn.run("bbb:app", host="127.0.0.1", port=8080, reload=True)
复制代码
运行结果：
  

   

这里是Apifox的利用截图：

三、路由分发

3.1、为什么需要路由分发？

在小型项目中，全部路由都写在 main.py 中尚可接受。但随着项目规模扩大（如构建包罗用户、订单、商品等多个模块的电商系统），将全部路由会合在一个文件会导致：


  • 代码痴肥：数千行代码堆积，难以阅读和维护。
  • 协作困难：多人同时修改同一文件容易引发冲突。
  • 复用性差：雷同功能的路由无法快速移植到其他项目。
路由分发（Route Distribution）通过 模块化拆分路由，将差别功能的路由分散到多个文件中，最终通过统一入口集成，完善解决上述问题。
3.2、图书管理系统

   cbs.py源码   
  1. # 出版社分发路由配置
  2. from fastapi import APIRouter
  4. api_cbs = APIRouter()
  6. @api_cbs.get("/get")
  7. async def get_test():
  8.     return {"methods": "出版社分发路由get方法"}
  10. @api_cbs.post("/post")
  11. async def post_test():
  12.     return {"methods": "出版社分发路由post方法"}
  14. @api_cbs.put("/put")
  15. async def put_test():
  16.     return {"methods": "出版社分发路由put方法"}
  18. @api_cbs.delete("/delete")
  19. async def delete_test():
  20.     return {"methods": "出版社分发路由delete方法"}
复制代码
      ts.py源码      
  1. # 图书分发路由配置
  2. from fastapi import APIRouter
  4. api_ts = APIRouter() # 创建路由
  6. @api_ts.get("/get")
  7. async def get_test():
  8.      return {"methods": "图书分发路由get⽅法"}
  10. @api_ts.post("/post")
  11. async def post_test():
  12.     return {"methods": "图书分发路由post⽅法"}
  14. @api_ts.put("/put")
  15. async def put_test():
  16.     return {"methods": "图书分发路由put⽅法"}
  18. @api_ts.delete("/delete")
  19. async def delete_test():
  20.     return {"methods": "图书分发路由delete⽅法"}
复制代码
  zz源码
  
  1. # 图书分发路由配置
  2. from fastapi import APIRouter
  4. api_ts = APIRouter() # 创建路由
  6. @api_ts.get("/get")
  7. async def get_test():
  8.      return {"methods": "图书分发路由get⽅法"}
  10. @api_ts.post("/post")
  11. async def post_test():
  12.     return {"methods": "图书分发路由post⽅法"}
  14. @api_ts.put("/put")
  15. async def put_test():
  16.     return {"methods": "图书分发路由put⽅法"}
  18. @api_ts.delete("/delete")
  19. async def delete_test():
  20.     return {"methods": "图书分发路由delete⽅法"}
复制代码
  main源码
  
  1. from fastapi import FastAPI
  2. from csdn.ts import api_ts
  3. from csdn.cbs import api_cbs
  4. from csdn.zz import api_zz
  5. app = FastAPI()
  7. #include_router()⽅法，⽤于将分发路由添加到app中，prefix参数为路由前缀，tags参数为标签
  8. app.include_router(api_ts, prefix="/ts", tags=["图书"])
  9. app.include_router(api_cbs, prefix="/cbs", tags=["出版社"])
  10. app.include_router(api_zz, prefix="/zz", tags=["作者"])
复制代码
  运行结果：
   

   

   

   提示：其他的需要访问的时候要利用Apifox来访问，由于其他的http的请求方式都不是get不能利用欣赏器直接访问。
    四、request对象的入门

   在现实开发过程中，有些时候我们需要通过Request对象直接获取⼀些信息，如：我们希望获取客户端的 IP等信息，此时我们在路由利用函数中直接界说类型为Request的对象参数，就可以在代码中使⽤Request对象进⾏数据的获取。     假设在路由函数中界说了request:Request，那么该对象可以获取到哪些信息呢？   
   
 代码示例：
  1. from fastapi import FastAPI,Request
  2. @app.put("/req/")
  3. async def req(request: Request):
  4.     req_method = request.method #请求的方式
  5.     req_url = request.base_url # 请求的路径
  6.     req_port = request.url.port  #请求的端口
  7.     res_json = request.json() # 请求json数据
  8.     res_arg1 = request.url.query # 请求查询参数1
  9.     res_arg2 = request.query_params # 请求查询参数2
  10.     print(f"请求的方式:{req_method},请求的路径:{req_url},#请求的端口:{req_port},请求json数据:{res_json}"
  11.           f"请求查询参数1:{res_arg1},请求查询参数2:{res_arg2}")
复制代码
在Aifox中发送请求:
参数：

json参数： 

运行结果：

五、总结

FastAPI 依附其高性能和开发效率，已成为构建现代 API 的首选框架。通过本文的学习，你已经掌握了：

  • 底子路由计划与参数验证
  • 模块化路由管理（APIRouter）
  • 请求元数据处置惩罚（Request 对象）
  • 异步编程与高级功能
  • 常见的http状态码提示的意思：
    1.   200：请求成功的状态码
    2.   404：页面找不到
    3.   422：请求体中数据有问题（格式不正确，名字匹配不对）
    4.   405：请求的方式不匹配（如路径是get形式，但是函数上面写的是其他的请求类型）
    5.   500：后台服务器程序出错d
    复制代码
无论是构建微服务、实时应用还是数据处置惩罚接口，FastAPI 都能提供强大的支持。下一步可探索其与 SQL 数据库、WebSocket 或分布式使命队列的集成，进一步提升项目复杂度。
延伸阅读


  • 官方文档：FastAPI Documentation
  • 实战项目：FastAPI + SQLAlchemy 用户管理系统


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

惊雷无声

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

运维 CIO 存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表