当前位置: 首页 > news >正文

FastAPI系列(02):第一个示例

 


本系列汇总,请查看这里:https://www.cnblogs.com/uncleyong/p/19503695

 

python环境

python

image

 

pycharm

image

  

FastAPI安装

pip install fastapi

安装后就包好了pydantic、starlette

image

 

另外,FastAPI 推荐使用 uvicorn 来运行服务(Uvicorn 是基于 uvloop 和 httptools 构建的闪电般快速的 ASGI 服务器),所以还需要安装uvicorn

pip install uvicorn
 

示例及解释

步骤

(1)导入FastAPI
(2)创建一个 app 实例
(3)编写一个路径操作装饰器(如 @app.get("/"))
(4)编写一个路径操作函数(如下面的 def home(): ...)
(5)定义返回值
(6)运行开发服务器(如:uvicorn main:app --reload)

  

示例

from fastapi import FastAPI  # FastAPI是一个为API提供了所有功能的Python类app = FastAPI()  # app这个实例是创建你所有API的主要交互对象。这个app也会被uvicorn所引用@app.get("/")
def home():return {"msg": "welcome"}@app.get("/shop")
def shop():return {"shop": "商品信息"}

  

启动服务:命令方式

uvicorn quickstart:app --reload
quickstart:文件quickstart.py
app:quickstart
--reload: 热启动,代码修改后服务会自动重启,方便代码的开发

image

 

请求

image

 

启动服务:直接启动

from fastapi import FastAPI
import uvicornapp = FastAPI()@app.get("/")
def home():return {"msg": "welcome"}@app.get("/shop")
def shop():return {"shop": "商品信息"}if __name__ == '__main__':uvicorn.run("quickstart:app", port=8001, reload=True)

  

run方法的可选参数很多,还有host等

image

 

image

 

image

 

交互式API文档

fastapi有着非常棒的交互式API文档,基于 OpenAPI 规范,能自动生产交互式API文档,支持 Swagger UI 和 ReDoc 两种交互式界面

Swagger UI

http://127.0.0.1:8001/docs

image

 

接口调试

点击“Execute”

image

 

点击“Execute”

image

 

ReDoc

http://127.0.0.1:8001/redoc

image

 

 

 

 
http://www.jsqmd.com/news/285650/

相关文章:

  • DeepSeek+Cursor封神指南:AI驱动编码全流程实战(含代码精解)
  • 心愈语伴:DeepSeek+Qwen2.5打造专属情感聊天工具全教程
  • 2026年会议纪要工具top9_工具_测评_ASR
  • Vue3+Cesium教程(38)--动态雾浓度、颜色
  • 一天一个Python库:requests - 简单好用的HTTP请求库
  • Vue3+Cesium教程(37)--下雪啦!动态设置降雪效果
  • 星瞳OpenMV官方机械臂教程|从零开始:Robot Arm机械臂快速上手
  • 【docker部署milvus向量库和可视化界面attu】
  • PX4中关于GPS质量检测和相关控制参数
  • PX4导航遇到GPS数据丢失的处理和相关控制参数
  • Java小白求职者面试:从Spring Boot到微服务架构设计的问答解析
  • day162—递归—买卖股票的最佳时机Ⅱ(LeetCode-122)
  • day163—递归—买卖股票的最佳时机含冷冻期(LeetCode-309)
  • Jupyter Notebook的5个实用技巧,可视化模型训练过程
  • send-proxy vs send-proxy-v2 vs send-proxy-v2-ssl
  • 完整教程:Spring Boot 中的定时任务:从基础调度到高可用实践
  • 北京汽车美容哪里好?五方天雅汽车服务园全面评测
  • 通过pm2以cluster模式多进程部署next.js
  • 学霸同款8个一键生成论文工具,研究生高效写作必备!
  • Jetson 磁盘加密自动解锁全链路:initrd / nvluks-srv-app / OP-TEE TA / EKB 一次讲清
  • 2026医疗级弹力袜如何选择?medi迈迪专业测评与多品牌对比指南
  • 2026最新权威推荐:洗护用品来料加工首选这家就对了!
  • c# await 异步编程工具类
  • 算法题:字符串转换成整数。
  • ASP.NET Core面试精讲系列三
  • 导师推荐9个AI论文工具,助你轻松搞定研究生论文写作!
  • 基于SpringBoot的高校综合医疗健康服务管理系统设计与实现
  • 别再自己硬扛了!上海靠谱心理咨询机构实测 TOP5,情绪内耗真的有解
  • 059.同余与逆元
  • 消费品营销战略咨询公司怎么选?哪家靠谱?