前言
终于有了第一个使用 FastApi 编写的线上服务, 在开发的过程中还是遇到了些问题, 这里记录一下
正文
目录结构
我们知道, FastApi 的启动方式推荐使用 uvicorn, 其启动方式大致为 uvicorn main:app, 实际上 main 为该文件的名字, app 为生成的 FastApi 对象, 那么, 对于一个比较大的项目, 我们应该怎样去布局项目呢? 我们参考了 https://github.com/nsidnev/fastapi-realworld-example-app 他是在名为 app 的文件夹中的 main.py 文件存放最大的 app, 在 该文件夹下存放各种逻辑文件, 例如: 基础的数据库相关放在 db 文件夹中, 公共的逻辑放在 core 文件夹中, 接口相关放在 api 文件夹中等等...
因为 app 已经放置在app文件夹中的 main.py 文件中, 启动时则是在根目录输入 uvicorn app.main:app
main.py
多级路由处理
类似于 Flask 的蓝图, FastApi 有更为简单的写法
这里以我们的项目为例, 我们有多层, 最*的 app 在 app 文件夹的 main.py 中, files 相关的 api 在 app > api > routers > files > api.py 中
我们从最里层的 api.py 看起, 最里层的 app > api > routers > files > api.py 大致是这样的
在 FastApi 中, 多层路由的每一层都可以设置生成一个 APIRouter 对象
我们再看上一层, 也就是 app > api > routers > api.py
这个 api.py 作为 routers 的整个的 router, 同样生成了 APIRouter 对象, 但是该对象因为并不是最下层的路由, 所以导入下层路由的 router 通过 router.include_router 注册到这个上层路由中, prefix 是路由前缀
我们再看 app > main.py
在最外层, 我们就生成了需要使用 uvicorn 启动的 app 对象, app 对象可以直接使用 include_router 注册路由, 那么其实结构是 最底层的 router 直接面向逻辑, 而外层的一层都通过 include_router 注册他, 同时在注册时可以设置前缀等操作