FASTAPI新项目指北

  1. 每个临时方案都是未来重构的债务,要做就一开始就做到完美
  2. precommit,配置black isort
  3. 撰写单测和集成测试,每次commit自动进行,单测真的很有用
  4. 善用linter
  5. database索引添加监控,使用alembic控制历史版本
  6. ID以后都用BIGINT,在basemodel里就修改成bigint
  7. 新建完毕项目之后一定要把model补全,model是一切的基础
  8. 本地开发和测试的数据库的名字一定要一样
  9. 蛇形命名
  10. created_at带时间的全局用同一种格式,最好写全局时间中间件
  11. 不要用已弃用的utcnow和onevent
  12. page_num和page_size要一开始就有全局组件
  13. 有什么看不顺眼的立马就改了
  14. 给前端的错误提示要是中文
  15. api路径里不允许出现-和复数和_,都用单数
  16. 接口的响应要走统一的控制器
  17. code message data包装响应