{"id":25547010,"url":"https://github.com/fishjar/flask-rest-boilerplate","last_synced_at":"2025-04-11T19:57:30.498Z","repository":{"id":39841421,"uuid":"221357229","full_name":"fishjar/flask-rest-boilerplate","owner":"fishjar","description":"flask rest bolierplate","archived":false,"fork":false,"pushed_at":"2022-05-25T02:39:59.000Z","size":84,"stargazers_count":2,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T15:53:05.255Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fishjar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-13T02:40:44.000Z","updated_at":"2022-01-12T07:06:15.000Z","dependencies_parsed_at":"2022-08-27T19:22:19.278Z","dependency_job_id":null,"html_url":"https://github.com/fishjar/flask-rest-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjar%2Fflask-rest-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjar%2Fflask-rest-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjar%2Fflask-rest-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishjar%2Fflask-rest-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fishjar","download_url":"https://codeload.github.com/fishjar/flask-rest-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248473112,"owners_count":21109628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-02-20T09:19:09.716Z","updated_at":"2025-04-11T19:57:30.474Z","avatar_url":"https://github.com/fishjar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# flask rest boilerplate\n\n## 使用指引\n\n```sh\n# 虚拟环境\n# apt-get install python3-venv\npython3 -m venv venv\n\n# 激活\n. venv/bin/activate\n\n# 安装依赖\n# pip install Flask\n# pip install Flask-SQLAlchemy\n# pip install flask-marshmallow\n# pip install marshmallow-sqlalchemy\n# pip install PyJWT\n# pip install schema\n# pip install pymysql\npip install -r requirements.txt\n\n# 环境变量\nexport FLASK_APP=flaskr\n# export FLASK_ENV=production # 缺省值\n# export FLASK_ENV=testing\nexport FLASK_ENV=development\n\n# 初始化\nflask init-db\n\n# 运行\nflask run\n\n# 打开一个 Shell\nflask shell\n\n# 导出依赖\npip freeze \u003e requirements.txt\n```\n\n### 生产部署\n\n```sh\n# 依赖\npip install gunicorn\npip install gevent\n\n# 如有需要\n# 启动一个数据库\nsudo docker-compose -f docker-compose.mysql.yml up -d\n\n# 运行\n# gunicorn main:app -w 4 -e FLASK_ENV=production -b :8000\ngunicorn -c gunicorn.py main:app\n```\n\n### docker 部署\n\n```sh\n# 编辑环境变量\nvi .env.prod\n\n# 启动\ndocker-compose up -d\n\n# 初始化数据\ndocker-compose exec web flask init-db\n\n# 测试\ncurl 127.0.0.1:8000\ncurl -H \"Content-Type: application/json\" -d '{\"userName\":\"gabe\",\"password\":\"123456\"}' 127.0.0.1:8000/login/account\n\n# 进入容器\ndocker-compose exec web bash\ndocker-compose exec db bash\n```\n\n## 存在问题\n\n- （已解决，存小小问题）`Relationships` 问题： [参考](https://docs.sqlalchemy.org/en/13/orm/basic_relationships.html)\n  - 模型相互引用问题，网上很多类似问题：[参考](https://stackoverflow.com/questions/34421205/sqlalchemy-model-circular-import/34503823),[2](https://stackoverflow.com/questions/58095513/flask-sqlalchemy-relationship-error-name-classname-is-not-defined-using-diff)\n  - `Menu` 自引用问题，`remote_side=[id]` 的 `id`在`BaseModel`定义，如何引入\n  - `User`、`Group`、`UserGroup` 相互引用问题\n- 部分错误无法被`_handle_exception`捕获，而是被内置处理器捕获了\n- （已解决）暂无优雅的数据校验，`sqlalchemy` 推荐的校验方式很繁琐\n\n## 目录结构\n\n```sh\n├── docker-compose.mysql.yml\n├── docker-compose.yml\n├── Dockerfile\n├── flaskr\n│   ├── config.py\n│   ├── handler\n│   │   ├── Auth.py\n│   │   ├── Group.py\n│   │   ├── __init__.py\n│   │   ├── Login.py\n│   │   ├── Menu.py\n│   │   ├── Role.py\n│   │   ├── UserGroup.py\n│   │   └── User.py\n│   ├── __init__.py\n│   ├── model\n│   │   ├── Auth.py\n│   │   ├── Base.py\n│   │   ├── Group.py\n│   │   ├── __init__.py\n│   │   ├── Menu.py\n│   │   ├── Role.py\n│   │   ├── UserGroup.py\n│   │   └── User.py\n│   ├── router\n│   │   └── __init__.py\n│   └── utils\n│       ├── auth.py\n│       ├── bp.py\n│       ├── cmd.py\n│       ├── err.py\n│       ├── __init__.py\n│       ├── jwt.py\n│       ├── log.py\n│       └── __pycache__\n├── gunicorn.py\n├── LICENSE\n├── main.py\n├── README.md\n└── requirements.txt\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffishjar%2Fflask-rest-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffishjar%2Fflask-rest-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffishjar%2Fflask-rest-boilerplate/lists"}