安装fastAPI
打开cmd命令行,运行
pip install fastapi
还会用到一个ASGI服务器,生产环境一般用uvicorn
pip install uvicorn
快速启动
1. 创建python文件
from fastapi import FastAPI # FastAPI 是一个为你的 API 提供了所有功能的 Python 类。
app = FastAPI() # 这个实例将是创建你所有 API 的主要交互对象。这个 app 同样在如下命令中被 uvicorn 所引用
@app.get("/") # 装饰器 路由映射
async def root():
return {"message": "Hello fastAPI"}
2. 终端运行
打开终端,用uvicorn启动服务,注意,要CD进入到项目文件夹下
启动命令:
uvicorn main:app --reload
其中main是服务源码文件,不带.py后缀
app是FastAPI的实例对象名
--reload 代表服务随源代码的变动实时更新
例:下图中实际运行代码为uvicorn "03 fastapi quickstart:app" --reload
3. 添加入口函数运行
为了不每次都在终端输命令运行,我们可以在文件里添加程序入口,点击运行时会自动使用Uvicorn启动服务
代码如下,需要按照自己实际 文件名 和 实例名称 来修改
if __name__ == "__main__":
uvicorn.run("03 fastapi quickstart:app",port=8000,reload=True)
4. 完整代码
from fastapi import FastAPI # 导入 FastAPI 库,用于创建 API 应用
import uvicorn # 导入 Uvicorn 库,用于启动 FastAPI 应用
app = FastAPI() # 创建一个 FastAPI 应用实例
@app.get("/") # 装饰器,将GET请求映射到"/ "路径的 home 函数
async def home():
return {"userid":542656757} # 返回一个 JSON 对象,包含一个名为 'userid' 的键值对
if __name__ == "__main__": # 如果当前脚本被直接执行
uvicorn.run("03 fastapi quickstart:app",port=8000,reload=True) # 使用 Uvicorn 启动应用,在端口 8000 上运行,并启用代码热重载
调用API
启动服务,访问服务根路由
成功√
END——