fastapi教程,fastapi脚手架,轻松搭建生产级项目,从入门到开挂

fastapi非常奈斯作为API开发那是相当优秀的框架但我们在开发过程中前期搭建会花费大量的时间且还不尽人意。为此我集成了生产级脚手架fastapi-scaff一键生成项目或api让开发变得更简单。快速上手fastapi官方文档 请查看fastapi生产级脚手架 请查看先来了解FastAPIFastAPI以其高性能、易用性、可扩展性、丰富的功能以及活跃的社区和完善的文档等优势成为了现代Web开发的理想选择。无论是构建RESTful API、WebSocket实时通信、创建Web应用以及开发微服务等FastAPI都能提供强大的支持。高性能基于异步编程模型提供出色的性能和吞吐量。自动文档自动生成基于OpenAPI规范的API文档支持Swagger UI和ReDoc便于开发者使用和测试。数据验证利用Pydantic库进行强大的数据验证和转换确保数据的准确性和一致性。类型安全基于Python类型提示提供强类型支持减少常见错误提高代码可读性。易于使用简洁的API设计减少模板代码提高开发效率。扩展性强与Python生态系统无缝集成支持多种数据库和第三方库提供丰富的选择和灵活性。贴图可能较老请以最新版本功能为准贴图可能较老请以最新版本功能为准贴图可能较老请以最新版本功能为准初入项目1。安装(Python3.11)pipinstallfastapi-scaff2。创建项目fastapi-scaff newmyproj【其他模板】默认标准版轻量版fastapi-scaff new myproj -t light微小版fastapi-scaff new myproj -t tiny单一版fastapi-scaff new myproj -t single3。启动项目a. 进入上面创建的项目根目录b. 修改配置比如数据库等c. 安装依赖包pip install -r requirements.txtd. 启动项目(更多参数请自行指定)python runserver.py注意以上步骤仅为示例根据实际情况而定。进阶操作脚手架默认功能自动初始化配置初始化数据库初始化数据库连接注意指定的数据库需要提前创建模型表自动创建日志初始化redis初始化雪花生成器初始化自动注册路由自动添加中间件/异常处理…集成jwt/api-key集成sqlalchemy集成数据库迁移集成celery集成docker部署…x模块示例user1。配置修改环境配置默认位于项目根目下的config/.env文件主要确定yaml配置文件.env的配置也可以直接设置环境变量APP_ENV应用环境定位yaml文件YAML_PATHyaml路径指定yaml文件优于APP_ENV定位SNOW_DATACENTER_ID雪花算法数据中心id取值0-31在分布式部署时需确保每个节点的取值不同yaml文件的配置数据库默认sqlite(已集成3种数据库: sqlite、mysql、postgresql)在new项目时可通过-d参数指定no-表不集成如果在yaml文件中添加了新的配置需要在app/initializer/_conf.py文件中显性的将配置添加进去主要方便使用和维护2。api添加添加apifastapi-scaff add myapi可添加多个api用英文逗号分隔fastapi-scaff add myapi1,myapi2可通过-v参数指定版本默认v1fastapi-scaff add myapi -v vn可通过-s参数指定子目录默认空fastapi-scaff add myapi -s subdir添加成功会增加3个文件标准版:api层app/api/v1/myapi.py业务层app/services/myapi.py数据层app/models/myapi.py默认只需修改3文件即可当然特殊情况除外请根据自身需求修改3。celery集成方式1。new时指定参数--celeryfastapi-scaff new myproj --celery方式2。add时指定参数--celeryfastapi-scaff add mycelery --celery使用文档请自行查看celery项目中的README.md4。数据库迁移可通过参数--migration集成fastapi-scaff new myproj --migration示例generate:python runmigration.py generate initupgrade:python runmigration.py upgrade关于 alembic: 请点击5。docker部署请自行查看项目中的相关文件及文档6。接口文档访问地址注意ip与端口http://127.0.0.1:8000/docs如果打开失败请f12查看redoc.standalone.js等文件是否请求成功可打开vpn再访问或者手动预先单独访问下失败的链接(可能会访问成功)http://127.0.0.1:8000/redoc如果打开失败请f12查看swagger-ui-bundle.js等文件是否请求成功可打开vpn再访问或者手动预先单独访问下失败的链接(可能会访问成功)接口文档响应数据的配置主要通过路由装饰器的参数responses来指定封装了response_docs方法来生成所需的响应数据data: data文档key字段名value字段类型或示例其他参数请自行查看源码关于code:code为0表示操作成功【http状态码200】code非0表示操作失败【http状态码200】