学习完本节内容,我们至少可以 get 到以下技能:
① 如何创建一个 FastAPI 应用
② 如何启动一个 uvicorn 服务器
③ 如何注册路由(自动注册)
④ 如何注入全局依赖(类似于拦截器)并排除例外情况
⑤ 如何处理跨域问题
⑥ 如何接收请求参数,并对请求参数进行验证
⑦ 如何自定义异常并对其进行处理
目录
还不知道 FastAPI 是什么?它可是 Python 世界中最受欢迎的接口开发框架,特点可以用三个关键词来概括:运行极快,异步非阻塞,高效编码。想了解更多信息请参考官网文档:FastAPI
下面我们按照项目化的流程,来演示如何用 FastAPI 框架来搭建自己的 API 接口。
【正式开始】
一、安装模块
为了能正常使用 FastAPI 相关功能,我们需要事先安装好以下模块:
pip install fastapi
pip install uvicorn
二、规范项目结构
结构说明
main.py
FastAPI 应用的入口文件,在该文件中,我们启动了一个 uvicorn 服务器,它可以保证我们提供的 api 服务能够正常运行。
app.py
在该文件中,我们创建了一个 FastAPI 应用,并通过属性名称 app 将其暴露出去,方便在其它地方(main.py 模块)引用。
exception
异常处理目录,该目录下存放的是我们自定义的异常类。之所以要自定义异常,主要目的是为了统一我们的响应输出,因为默认的 HTTPException 异常通常不能满足需求。