快速创建Flask Restful API项目

前言

Python必学的两大web框架之一Flask,俗称微框架。它只需要一个文件,几行代码就可以完成一个简单的http请求服务。

但是我们需要用flask来提供中型甚至大型web restful api服务的时候就需要我们来规划项目结构。

Django 框架有自身的生成项目结构的命令和生成app的命令,但是Flask没有。

这篇文章主要介绍使用工具帮助我们进行一些Flask rest api项目初始化的工作

cookiecutter-flask-restful 介绍

cookiecutter-flask-restful是一个基于cookiecutterFlask rest api项目生成器,你可以用它快速生成Flask restful api项目。

目前支持的python版本:3.6 | 3.7 | 3.8

项目特性

  • Flask应用工厂函数,使用蓝图
  • 集成Flask命令行接口
  • 数据迁移
  • JWT登录认证
  • 分页工具类
  • 单元测试
  • 使用环境变量配置
  • 集成swagger UI

主要使用的包

  • Flask
  • Flask-RESTful
  • Flask-Migrate
  • Flask-SQLAlchemy
  • Flask-Marshmallow
  • Flask-JWT-Extended
  • marshmallow-sqlalchemy
  • passlib
  • tox
  • pytest
  • factoryboy
  • dotenv
  • apispec

快速开始

安装cookiecutter

$ pip3 install cookiecutter

创建第一个项目

$ cookiecutter https://github.com/karec/cookiecutter-flask-restful

一路按回车键,就会生成一个新项目。

项目名字暂且叫myproject, app名字暂且叫myapi

运行项目

如果项目使用了pipenv管理虚拟环境:

安装依赖:

$ cd myproject
$ pipenv install -r requirements.txt

# 进入到虚拟环境
$ pipenv shell

$ pip install -e .
$ myapi db upgrade
$ myapi init
$ myapi --help

启动项目:

$ pipenv run flask run

测试项目:

登录请求:

$ curl -X POST -H "Content-Type: application/json" -d ‘{"username": "admin", "password": "admin"}‘ http://localhost:5000/auth/login

登录返回:

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1ODYyMjUyNzIsIm5iZiI6MTU4NjIyNTI3MiwianRpIjoiZDM3NmViODktYWFkOC00ODZkLWE1NmUtZDdiNmQ3NjNhYmI2IiwiZXhwIjoxNTg2MjI2MTcyLCJpZGVudGl0eSI6MSwiZnJlc2giOmZhbHNlLCJ0eXBlIjoiYWNjZXNzIn0.-xCHCJHS3lKeiar-Z12HSOwd2DxAb9EeKFg9zMKWHfU",
  "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1ODYyMjUyNzIsIm5iZiI6MTU4NjIyNTI3MiwianRpIjoiMTcyNmI0ODEtMDJjYi00NWFhLTgyOWUtOGY0ODJlYmFlZTEyIiwiZXhwIjoxNTg4ODE3MjcyLCJpZGVudGl0eSI6MSwidHlwZSI6InJlZnJlc2gifQ.fpFH_vw8Lp-_xjDVoFLjF6HnjOKXR7PCLKIp8v9gSSU"
}


获取所有用户请求:

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1ODYyMjUyNzIsIm5iZiI6MTU4NjIyNTI3MiwianRpIjoiZDM3NmViODktYWFkOC00ODZkLWE1NmUtZDdiNmQ3NjNhYmI2IiwiZXhwIjoxNTg2MjI2MTcyLCJpZGVudGl0eSI6MSwiZnJlc2giOmZhbHNlLCJ0eXBlIjoiYWNjZXNzIn0.-xCHCJHS3lKeiar-Z12HSOwd2DxAb9EeKFg9zMKWHfU" http://127.0.0.1:5000/api/v1/users

获取所有用户返回:

{
    "total": 3,
    "pages": 1,
    "next": "/api/v1/users?page=1&per_page=50",
    "prev": "/api/v1/users?page=1&per_page=50",
    "results": [
        {
            "active": true,
            "id": 1,
            "email": "[email protected]",
            "username": "admin"
        },
        {
            "active": true,
            "id": 2,
            "email": "",
            "username": ""
        },
        {
            "active": true,
            "id": 3,
            "email": "string",
            "username": "string"
        }
    ]
}


刷新token请求:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZGVudGl0eSI6MSwiaWF0IjoxNTEwMDAwNDQxLCJ0eXBlIjoicmVmcmVzaCIsImp0aSI6IjRmMjgxOTQxLTlmMWYtNGNiNi05YmI1LWI1ZjZhMjRjMmU0ZSIsIm5iZiI6MTUxMDAwMDQ0MSwiZXhwIjoxNTEyNTkyNDQxfQ.SJPsFPgWpZqZpHTc4L5lG_4aEKXVVpLLSW1LO7g4iU0" http://127.0.0.1:5000/auth/refresh

刷新token返回:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0eXBlIjoiYWNjZXNzIiwiaWRlbnRpdHkiOjEsImlhdCI6MTUxMDAwMDYxOCwiZnJlc2giOmZhbHNlLCJqdGkiOiIzODcxMzg4Ni0zNGJjLTRhOWQtYmFlYS04MmZiNmQwZjEyNjAiLCJuYmYiOjE1MTAwMDA2MTgsImV4cCI6MTUxMDAwMTUxOH0.cHuNf-GxVFJnUZ_k9ycoMMb-zvZ10Y4qbrW8WkXdlpw"
}


如果没有使用pipenv管理虚拟环境,直接使用的系统python环境:

$ cd myproject
$ pip install -r requirements.txt
$ pip install -e .

# 初始化项目
$ myapi db upgrade
$ myapi init
$ myapi --help

测试项目同上

项目环境变量配置

环境变量在.flaskenv文件中

FLASK_ENV=development
FLASK_APP="myapp.app:create_app"
SECRET_KEY=changeme
DATABASE_URI="sqlite:////tmp/myapp.db"
CELERY_BROKER_URL=amqp://guest:[email protected]/  # only present when celery is enabled
CELERY_RESULT_BACKEND_URL=amqp://guest:[email protected]/  # only present when celery is enabled

请根据你的实际情况进行配置。

测试

直接用tox

$ tox

使用pytest

$ pip install pytest pytest-runner pytest-flask pytest-factoryboy factory_boy
$ pytest

使用docker-composeMakefile

make tests

如果出现连接失败,你需要更改redis | rabbitmq地址

使用wsgi服务启动

gunicorn示例:

$ pip install gunicorn
$ gunicorn myapi.wsgi:app

uwsgi示例:

$ pip install uwsgi
$ uwsgi --http 127.0.0.1:5000 --module myapi.wsgi:app

使用celery

启动celery

$ celery worker -A myapi.celery_app:app --loglevel=info

如果你的配置没有问题,在终端你会看到:

[tasks]
  . myapi.tasks.example.dummy_task

调用task:

>>> from myapi.tasks.example import dummy_task
>>> result = dummy_task.delay()
>>> result.get()
‘OK‘

使用celery extension:

>>> from myapi.extensions import celery
>>> celery.send_task(‘myapi.tasks.example.dummy_task‘).get()
‘OK‘

使用Docker

注意:目前Docker的配置只有开发环境

构建镜像:

$ docker build -t myapp .

启动镜像:

$ docker run --env-file=.flaskenv myapp myapi init
$ docker run --env-file=.flaskenv -p 5000:5000 myapp myapi run -h 0.0.0.0
 * Serving Flask app "myapi.app:create_app" (lazy loading)
 * Environment: development
 * Debug mode: on
 * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 214-619-010

使用docker-compose启动:

$ docker-compose up -d
$ docker ps
$ docker exec -it <container_id> myapi init

使用docker-composeMakefile启动

make init

Makefile 命令

make init # 初始化环境
make build # 构建镜像
make run # 启动镜像
make db-migrate # 迁移数据
make db-upgrade # 数据映射到数据库
make test # 执行测试

使用Swagger

打开UI页面地址:http://localhost:5000/swagger-ui

页面如下:

config.py文件进行配置:

  • APISPEC_TITLE: 页面标题,默认: {{cookiecutter.project_name}}
  • APISPEC_VERSION: api版本,默认: 1.0.0
  • OPENAPI_VERSION: OpenAPI 版本,默认: 3.0.2
  • SWAGGER_JSON_URL: JSON规范校验地址, 默认: /swagger.json
  • SWAGGER_UI_URL: 页面UI地址,默认: /swagger-ui
  • SWAGGER_URL_PREFIX: 蓝图URL前缀, 默认: None

Enjoy your code, good luck.

原文地址:https://www.cnblogs.com/DeaconOne/p/12652504.html

时间: 2024-11-07 01:44:40

快速创建Flask Restful API项目的相关文章

快速创建yii2 RESTful api的小记

1.复制backend的应用到同级目录,改名叫api 2.然后就是配置项修改,common和api目录下的 common下: bootstrap.php最后添加一行配置 api/config/main.php中修改,如下两处 如果是apache的话增加.htaccess文件,如下 gii生成对应的module.controller.model在api项目下 然后修改Idcontroller 然后查看添加简单数据查看结果 或者postman得到的结果

如何用rflask快速初始化Flask Restful项目

如何用rflask快速初始化Flask Restful项目 说明 多啰嗦两句 我们在创建flask项目的时候,使用pycharm创建出来的项目比较简陋,而且随着项目的功能完善,项目目录结构会比较多,多个项目结构又不统一,熟悉项目需花费时间比较多,项目发布配置又需要自己重新写一套.本文章是针对Flask Restful Api项目进行的快速初始化,对于没有前后端分离的Flask项目也可作为参考. 安装rflask pip安装: pip install rflask 下载源码安装: 源码地址:htt

通过beego快速创建一个Restful风格API项目及API文档自动化(转)

通过beego快速创建一个Restful风格API项目及API文档自动化 本文演示如何快速(一分钟内,不写一行代码)的根据数据库及表创建一个Restful风格的API项目,及提供便于在线测试API的界面. 一.创建数据库及数据表(MySQL) #db--jeedev -- ---------------------------- -- Table structure for `app` -- ---------------------------- DROP TABLE IF EXISTS `a

Flask restful api与blueprint结合实践

所需依赖: Flask Flask-RESTful Python2.7 备注:flask-restful不能和flask的render_template模板结合使用,因为restfulapi的设计不是为了在flask里直接返回html. 在使用restful时,使用前后端分离模式. 本文档不包含flask的认证登陆功能 restful说明 restful把所有url请求当做资源, 资源下的get方法对应get请求,post方法对应post请求,put方法对应put请求,delete方法对应del

nginx+uwsgi阿里云ubuntu服务器上简单部署flask RESTful风格项目

ubuntu16.04上利用Nginx代理uwsgi处理Flask web应用 1.环境要求 ubuntu16.04  ----  阿里云的服务器 Nginx python2 uwsgi 2.简单介绍Nginx nginx是一个高性能的http和反向代理的服务器,Nginx采采用的epoll的机制,而没有使用select和poll,虽然,在用户活跃数量比较高的时候,epoll性能不如select,但是,我们用Nginx来作为web服务器还是很不错的.nginx是一个轻量级的web服务器,他占用内

Flask restful API如何解决跨站请求问题

如果像下面这样只是在return的response添加header是不行的: response = make_response(jsonify(response=get_articles(ARTICLES_NAME))) response.headers['Access-Control-Allow-Origin'] = '*' response.headers['Access-Control-Allow-Methods'] = 'POST' response.headers['Access-Co

测开大佬告诉你:如何5分钟快速创建restful风格的API接口-使用django restframework框架

一.思考?? 1.创建API接口难吗? 软件测试工程师: 只测过API接口, 从没创建过 应该需要掌握一门后端开发语言和后端开发框架吧!? 脑容量有限,想想就可怕 2.如何创建API接口呢? 使用Django restframework能快速创建符合restful风格的API接口 通过Django restframework框架提供的序列化器.视图集可轻轻松松实现 简单高效,学习成本低 二.搭建项目工程???? 1.创建项目 打开pycharm 创建项目 使用豆瓣源安装Django Django

在Ubuntu上快速搭建基于Beego的RESTful API

最近在研究Go,打算基于Go做点Web API,于是经过初步调研,打算用Beego这个框架,然后再结合其中提供的ORM以及Swagger的集成,可以快速搭建一个RESTful API的网站. 下面是具体做法: 1. 在Ubuntu中安装Go 1.8 默认Ubuntu apt-get提供的是Go 1.6,而我们要用最新的Go 1.8需要执行以下操作: 1.1 添加apt-get源并刷新 $ sudo add-apt-repository ppa:gophers/archive $ sudo apt

带你入门带你飞Ⅱ 使用Mocha + Chai + SuperTest测试Restful API in node.js

目录 1. 简介 2. 准备开始 3. Restful API测试实战 Example 1 - GET Example 2 - Post Example 3 - Put Example 4 - Delete 4. Troubleshooting 5. 参考文档 简介 经过上一篇文章的介绍,相信你已经对mocha, chai有一定的了解了, 本篇主要讲述如何用supertest来测试nodejs项目中的Restful API, 项目基于express框架. SuperTest 是 SuperAge