flask-restful-example
flask后端开发接口示例，利用Flask开发后端API接口。包含基本的项目配置、统一响应、MySQL和Redis数据库操作、定时任务、图片生成、项目部署、用户权限认证、报表输出、无限层级生成目录树、阿里云手机验证码验证、微信授权、Celery、单元测试、Drone等模块。
一、系列文章
- Flask后端实践 连载一 加载yaml配置文件
- Flask后端实践 连载二 yaml配置logger及logger使用
- Flask后端实践 连载三 接口标准化及全球化
- Flask后端实践 连载四 接口响应封装及自定义json返回类型
- Flask后端实践 连载五 Flask与SQLAlchemy的集成和简单使用
- Flask后端实践 连载六 基于Flask与SQLAlchemy的单表接口
- Flask后端实践 连载七 Flask使用redis数据库
- Flask后端实践 连载八 Docker+Gunicorn+Nginx部署Flask后端
- Flask后端实践 连载九 Flask-APScheduler定时任务与坑点解决方法
- Flask后端实践 连载十 Flask图形验证码生成及验证
- Flask后端实践 番外篇 Docker部署优化
- Flask后端实践 连载十一 Flask实现JsonWebToken的用户认证授权
- Flask后端实践 连载十二 Flask优雅的注册蓝图及自定义MethodView
- Flask后端实践 连载十三 Flask输出Excel报表
- Flask后端实践 连载十四 Flask输出World报表
- Flask后端实践 连载十五 实现自关联无限层级生成目录树
- Flask后端实践 连载十六 Flask实现微信Web端及APP端登录注册
- Flask后端实践 连载十七 Flask实现手机验证码登录注册
- Flask后端实践 连载十八 Flask输出PDF报表
- Flask后端实践 连载十九 Flask工厂模式集成使用Celery
- Flask后端实践 连载二十 Flask接口单元测试+测试报告+测试覆盖率
- Python基于Drone的CI-CD（代码检查、测试、构建、部署）实践
二、部署
1. 拉取代码
- 切换到
/projects目录(没有就先新建目录sudo mkdir /projects)，执行命令cd /projects - 执行命令
sudo git clone https://github.com/qzq1111/flask-restful-example.git拉取代码 - 切换到
/projects/flask-restful-example目录，执行命令cd /projects/flask-restful-example
2. 构建镜像
- 在当前目录
/projects/flask-restful-example中构建镜像 - 执行命令
sudo docker build . -t=flask-restful-example:latest构建，等待构建完成 - 执行命令
sudo docker images，查询构建好的镜像flask-restful-example
3. 运行容器
- 在当前目录
/projects/flask-restful-example中运行容器 - 执行命令
sudo docker-compose up -d - 执行命令
sudo docker ps查询容器是否运行
4. 配置修改
4.1 config/config.yaml配置
- SQLALCHEMY_DATABASE_URI：数据连接
- REDIS_HOST：Redis连接，此处如果使用的是docker-compose的link，修改为对应服务名称默认为
flask_redis
4.2 docker-compose配置
- image：构建的镜像名称
- container_name：启动之后容器名称
- ports：容器端口与宿主端口映射
- volumes：容器内部文件与宿主文件映射（持久化）
- links：链接的容器，容器之间使用服务名访问
4.3 gun.conf配置
- bind：flask启动端口。一般不用修改，服务在容器内启动的。
- worker_class：flask启动的模式，有许多支持启动的方式，按需取舍。
4.4 nginx配置
server {
listen 5000;
server_name localhost;
# api代理转发
location /api {
proxy_redirect off;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_pass http://127.0.0.1:3010/api;
}
# 报表下载
location /report {
alias /projects/flask-restful-example;
}
}
5.备注
- 修改配置文件之后最好重启容器，
sudo docker-compose restart - 如果有任何问题可以加扣扣：
472597709
三、写在最后
文章中的内容来自于本人工作中的总结，希望通过这一系列的文章，能够帮助到更多使用Flask开发后端接口的朋友。
四、赞赏
如果觉得对你有帮助，也可以请我吃个午饭。
| 微信￥9.9 | 支付宝￥9.9 |
|---|---|
-
Github项目地址：https://github.com/lalala223/flask-restful-example 项目结构 . ├── LICENSE ├── README.md ├── config.py ├── example │ ├── __init__.py │ ├── app.py │ ├── common │ │ ├── __init__.py │ │
-
flask-restful是一个用于快速创建restful api接口的flask扩展。使用flask-restful可以很快速方便地创建一个restful风格的接口应用程序。 1、安装 pip install flask_restful 2、全部代码 from flask import flask from flask_restful import reqparse, abort, api, r
-
from flask import Flask from flask_restful import Resource, Api,reqparse from flask_docs import ApiDoc app = Flask(__name__) restful_api = Api(app) ApiDoc(app, title='Sample App Restful', version='
-
Flask-RESTful是一个用于快速创建RESTful API接口的Flask扩展。使用Flask-RESTful可以很快速方便地创建一个RESTful风格的接口应用程序。 1、安装 pip install flask_restful 2、全部代码 from flask import Flask from flask_restful import reqparse, abort, Api, R
-
作为一个网络应用程序，特别是后端的网络应用；它需要应对各种各样的前端设备的请求比如：手机、平板、桌面电脑以及其他的专用设备。因此，必须要有一种统一的机制，方便不同的前端设备和后端进行通信。这也导致了API架构的流行，而Restful API是目前比较成熟的一套互联网应用程序设计理念。 如何设计API参考博客：http://www.ruanyifeng.com/blog/2014/05/restfu
-
Flask-RESTful 是一个 Flask 扩展，它添加了快速构建 REST APIs 的支持。它当然也是一个能够跟你现有的ORM/库协同工作的轻量级的扩展。Flask-RESTful 鼓励以最小设置的最佳实践。如果你熟悉 Flask 的话，Flask-RESTful 应该很容易上手。 用户指南 这部分文档将向你展示如何在 Flask 中使用 Flask-RESTful。 安装 快速入门 一个
-
一、扩展 Flask-RESTful 1、内容协商： Flask-RESTful 仅配置为支持 JSON。 要添加其它的 mediatypes 到你的 API 中，你需要在 Api 对象中声明你支持的表示。 app = Flask(__name__) api = restful.Api(app) @api.representation('application/json') def output
-
Note You are not using the most up to date version of the library. 0.3.6 is the newest version. Quickstart It’s time to write your first REST API. This guide assumes you have a working understanding o
-
当前，前后端分离已是大势所趋，那么写接口的时候，我们通常希望我们的接口不被恶意请求，这就需要限制单个IP的请求频率。这里我们用装饰器实现一下： from flask import Flask, request from flask_restful import Api, Resource from flask_limiter import Limiter from flask_limiter.ut
-
在前面，我们介绍了 REST Web 服务，并使用 Flask 提供服务。这里，我们使用第三方库 Flask-RESTful，它使得在 Flask 中提供 REST 服务变得更加简单。 安装 使用 pip 安装： $ pip install flask-restful 使用 下面我们主要使用官方文档的例子进行说明。 Hello World 我们先来看一个简单的例子。 # -*- coding: u
-
cookiecutter-flask-restful Cookiecutter template for flask restful, including blueprints, application factory, and more Introduction This cookie cutter is a very simple boilerplate for starting a REST
-
flask-restful-swagger What is flask-restful-swagger? flask-restful-swagger is a wrapper for flask-restful which enables swagger support. In essence, you just need to wrap the Api instance and add a fe
-
问题内容： 我想知道如何通过创建API服务来上传文件？ 路线 然后是HTML 我已经在服务器端启用了CORS 如果重要的话，我正在使用angular.js作为前端和ng-upload，但是也可以使用CURL语句！ 问题答案： 您应该处理流，如果它是wav，则上面的代码有效。对于图像，您应该存储在数据库上或上传到AWS S3或Google Storage
-
Flask-RESTful 是一个 Flask 扩展，它添加了快速构建 REST APIs 的支持。它当然也是一个能够跟你现有的ORM/库协同工作的轻量级的扩展。Flask-RESTful 鼓励以最小设置的最佳实践。如果你熟悉 Flask 的话，Flask-RESTful 应该很容易上手。 使用 pip 安装 Flask-RESTful: pip install flask-restful 开发
-
翻译者注：本系列的原文名为：Designing a RESTful API with Python and Flask ，作者是 Miguel Grinberg 。 近些年来 REST (REpresentational State Transfer) 已经变成了 web services 和 web APIs 的标配。 在本文中我将向你展示如何简单地使用 Python 和 Flask 框架来创建