FastAPI 超精简入门搭建教程(环境配置+启动+接口文档)
目录
一、Conda 虚拟环境配置
二、安装核心依赖
三、编写最简启动代码
四、三种项目启动方式
五、项目访问与接口文档
六、高频报错快速解决
一、Conda 虚拟环境配置
使用独立虚拟环境隔离项目依赖,避免全局环境冲突,这里以3.12版本为例,终端执行以下命令:
# 创建虚拟环境 conda create -n fastapi_env python=3.12 # 激活虚拟环境 conda activate fastapi_env # 退出虚拟环境(备用命令) conda deactivate二、安装核心依赖
激活环境后安装 FastAPI 框架和 uvicorn 运行服务器,指定稳定版本,规避兼容问题:
# 安装标准版FastAPI pip install "fastapi[standard]" # 指定版本安装(可选,稳定推荐) pip install fastapi==0.115.12 # 安装运行服务器 pip install uvicorn==0.34.2三、编写最简启动代码
新建main01.py,写入基础项目代码,包含根接口和服务启动配置:
from fastapi import FastAPI import uvicorn app = FastAPI() # 基础根接口 @app.get("/") def read_root(): return {"Hello": "World"} # 项目启动入口 if __name__ == '__main__': # 热更新+调试模式,本地开发专用 uvicorn.run('main01:app', host='0.0.0.0', port=8000, reload=True, debug=True)核心要点:main01:app必须严格对应「文件名:实例变量名」,拼写错误会直接启动失败。
四、三种项目启动方式
三种方式按需选用,均支持热更新开发:
# 方式1:直接运行脚本(最常用) python main01.py # 方式2:终端uvicorn命令启动 uvicorn main01:app --reload # 方式3:FastAPI官方调试启动 fastapi dev main01.py五、项目访问与接口文档
项目启动成功后,可直接访问以下地址,FastAPI 自带自动生成接口文档:
- 项目根地址:
http://127.0.0.1:8000- 交互式调试文档(推荐开发使用):
http://127.0.0.1:8000/docs- 标准规范文档(适合查阅):
http://127.0.0.1:8000/redoc
六、高频报错快速解决
针对访问URL报错、页面打不开问题,汇总核心解决办法:
- 文档/接口无法访问:优先检查项目是否真正启动成功、8000端口是否被占用
- 模块不存在报错:确认已激活虚拟环境,依赖安装完整
- 启动报错:核对文件名、
main01:app拼写(区分大小写)
