tomaszguzialek/flask-api

flask-api ![Build Status]([***]

基于Python Flask框架的RESTful API示例镜像，提供完整的开发、部署及配置指南。

镜像概述

本镜像展示了如何使用Flask构建RESTful API，并支持多种部署方式（手动部署、Docker容器部署、Fabric自动化部署），同时提供灵活的配置选项和测试用例。

核心功能

1. 基于Flask实现RESTful API接口
2. 支持Gunicorn服务器手动部署
3. 提供Docker容器构建与运行脚本
4. 包含Docker Compose配置（与MySQL容器联动）
5. 支持Fabric自动化部署到远程Ubuntu机器
6. 可通过环境变量灵活调整配置参数
7. 附带单元测试用例

使用场景

• 学习Flask框架及RESTful API开发
• 快速搭建API服务原型进行验证
• 掌握Docker部署Python API的方法
• 了解Fabric自动化部署流程

配置说明

默认情况下，应用会初始化SQLite数据库（路径：/tmp/flask-api.db）并在启动时添加示例数据（配置文件位于src/conf/flask_api_conf.py）。可通过以下方式调整配置：

1. 设置环境变量FLASK_API_CONF指定自定义配置文件
2. 使用FLASK_API_前缀的环境变量覆盖单个配置项（例如FLASK_API_INIT_SAMPLE_DATA=False）

Docker部署示例

构建镜像

bash
docker build -t tomaszguzialek/flask-api .

运行容器（默认配置）

bash
docker run -d -p 5000:5000 tomaszguzialek/flask-api

运行容器（自定义配置）

bash
docker run -d -p 5000:5000 -e FLASK_API_INIT_SAMPLE_DATA=False tomaszguzialek/flask-api

Docker Compose部署（与MySQL联动）

bash
docker-compose up -d

测试

运行单元测试：

bash
python -m unittest discover