zhangnian / fastapi

基于flask的快速开发Web API的框架

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

fastapi

基于flask的快速开发Web API的框架

安装

pip install -r requirments.txt

集成的第三方组件

Sentry

在配置文件中可以控制是否开启sentry功能,如果开启,当程序出现异常时会将异常信息上报至配置文件中指定的sentry server。

flask_sqlalchemy

sqlalchemy的flask扩展

flask_marshmallow

对象的序列化/反序列化库,用于实现db.Model对象和JSON之间的快速映射

Redis

在utils包中简单封装了一个全局的redis客户端,redis的服务器配置从配置文件中读取

Celery

在api.v1.async下有一个使用celery实现异步任务的demo

扩展的功能

  • 使用flask blueprint对项目进行模块化划分
  • 自动导入API目录下的blueprint
  • 封装日志组件,按照每天进行日志滚动
  • 规范API响应格式,data只能是字典或列表类型
code:
  0     成功
  负数  系统级错误
  正数  业务级错误,按照模块划分,比如1-100代表用户模块,101-200代表商品模块
data: 只能返回字典(单个对象)或列表(多个对象)
{
    "code": 0,
    "data": {},
    "msg": ""
}

快速开始

TODO

About

基于flask的快速开发Web API的框架

License:MIT License


Languages

Language:Python 99.6%Language:Shell 0.4%