10分钟,带你用Python构建RESTful API 服务
off999 2024-12-09 16:20 15 浏览 0 评论
1. 前言
上一篇文章,介绍了使用 Java + Spring Boot + MyBatis 构建 RESTful API 的详细步骤;很多小伙伴表示,更愿意用 Python 编写 RESTful API 服务,希望我能写一下
本篇将以 Python 开始介绍搭建 RESTful API 的流程 ,使用的技术栈是:Flask + flask-restful + flasgger
2. 安装依赖
使用 Python 编写 RESTful API 之前,我们需要先在虚拟环境内安装对应的依赖具体包含:
Flask- 基础 Web 框架
flask_restful- Flask 的扩展,增加了对快速构建 REST API 的支持
flasgger- flask 支持的 Swagger UI,可以生成 API 接口文档
# 安装flask
pip3 install flask
# 安装flask-restful
pip3 install flask-restful
# 安装flasgger
# 注意:需要更新setuptools
pip3 install -U setuptools
pip3 install flasgger
# 管理数据库的依赖
pip3 install flask_script
pip3 install flask_migrate
3. Hello World
首先,我们使用 Pycharm 创建一个 Flask Web 项目,初始化代码如下:
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world:
return 'Hello World!'
if __name__ == '__main__':
app.run
从 flask_restful 文件中导入 Api、Resource 两个类,使用上面的 app 对象,构建一个 api 对象,接着准备一个列表数据
from flask_restful import Api,Resource
app = Flask(__name__)
# 实例化一个 Api 对象,用来创建、管理 RESTful Api
api = Api(app)
# 准备一个列表数据
datas = [{'id': 1, 'name': 'xag', 'age': 18}, {'id': 2, 'name': 'xingag', 'age': 19}]
然后,利用 Flask 中的 CBV 模式,创建一个 Resource 类的子类,用于定义资源路由
这里以 GET / POST 动作为例,重写 get、post 方法,并编写内部逻辑,返回数据即可
class UserView(Resource):
"""
通过继承 Resource 来实现调用 GET/POST 等动作方法
"""
def get(self):
"""
GET 请求
:return:
"""
return {'code': 200, 'msg': 'success', 'data': datas}
def post(self):
# 参数数据
json_data = request.get_json
# 追加数据到列表中
new_id = len(datas)+1
datas.append({'id':new_id,**json_data})
# 返回新增的最后一条数据
return {'code': 200, 'msg': 'ok', 'success': datas[new_id - 1]}
最后,使用 Api 的实例对象,将上面定义的资源,利用路径,完全暴露出去
# 暴露接口出去
# 资源路由:UserView
# 路径:/user
api.add_resource(UserView,'/user')
运行程序后,就可以拿 Postman 或 cURL 去测试接口了
4. 项目实战
在实际项目开发中,数据结构、层级关系往往要复杂很多,我们需要对项目进行一次整合,按功能进行封装,具体步骤如下:
第 1 步,编写配置文件
新建一个配置文件 config.py,将数据库( 以 Mysql 为例 )的连接信息,包含:用户名、密码、端口号、数据库名、连接驱动和 Swagger 的设置信息追加进去
# config.py
USERNAME = 'root'
PASSWORD = 'root'
HOSTNAME = "127.0.0.1"
PORT = '3306'
DATABASE = 'xag'
DIALECT = 'mysql'
DRIVER = 'pymysql'
# 连接数据的URI
DB_URI = "{}+{}://{}:{}@{}:{}/{}?charset=utf8".format(DIALECT, DRIVER, USERNAME, PASSWORD, HOSTNAME, PORT, DATABASE)
SQLALCHEMY_DATABASE_URI = DB_URI
SQLALCHEMY_TRACK_MODIFICATIONS = True
SWAGGER_TITLE = "API"
SWAGGER_DESC = "API接口"
# 地址,必须带上端口号
SWAGGER_HOST = "localhost:5000"
第 2 步,模型映射数据库
创建一个模型类 Foo 继承 SQLAlchemy 对象,使用 __tablename__ 指定生成数据表的名称、然后新增几个常用字段
# models.py
from exts import db
class Foo(db.Model):
"""
模型,将映射到数据库表中
"""
__tablename__ = 'foo'
# 主键ID
id = db.Column(db.INTEGER, primary_key=True, autoincrement=True)
# 名字
name = db.Column(db.String(100), able=False)
# 年龄
age = db.Column(db.INTEGER)
接着,创建 manage.py 文件
显式导入上面创建的 Foo 类,使用 flask_migrate 中的 Migrate 绑定 App 和数据库,利用 flask_script 中的 Manager 实例去添加一个脚本命令
# manager.py
from flask_migrate import Migrate, MigrateCommand
from flask_script import Manager
from exts import db
from api_app import app
from models import Foo
manager = Manager(app)
migrate=Migrate(app, db)
manager.add_command('db', MigrateCommand)
if __name__ == '__main__':
manager.run
需要注意的是,Foo 模型必须显式导入,否则没法映射到数据库中
最后,通过下面 3 个脚本命令,将模型映射到数据库中
除了第一次需要生成迁移脚本外,后面映射数据库,只需要执行后面两个命令即可
# 初始化迁移文件
python3 manager.py db init
# 映射到文件
python3 manager.py db migrate
# 映射到数据库
python3 manager.py db upgrade
打开 Navicat For Mysql,即可以看到刚刚映射过来的数据表及迁移表
第 3 步,创建资源路由
下面以创建列表查询( GET )、单条记录的查询( GET )、更新( PUT )、新增( POST )、删除( DELETE )为例
flask_restful 中的 marshal_with 类可以作为装饰器,定义到动作函数上,指定要返回的字段;然后使用 SQLAlchemy ORM 操作数据库,将数据直接进行返回
比如:返回获取数据列表
# api_foo.py
from flask_restful import Resource, fields, marshal_with, request
class FooListApi(Resource):
# 定义要返回的字段
resource_fields = {
'id': fields.Integer,
'name': fields.String,
'age': fields.String
}
# 装饰器,定义返回数据
@marshal_with(resource_fields)
def get(self):
"""
返回所有记录
:return:
"""
# 查询数据库
foos = db.session.query(Foo).all
return foos
对于新增一个对象( POST 动作)
# api_foo.py
class FooApi(Resource):
def post(self):
"""
创建一条记录
:return:
"""
# 参数
params = request.get_json
name = params.get("name")
age = params.get("age")
# 构建一个模型
foo = Foo(name=name, age=age)
# 加入到数据库
db.session.add(foo)
db.session.commit
return success("新增一条记录成功!")
第 4 步,返回数据统一化
为了保证返回的数据结构一致,可以将返回码、返回信息及数据进行一次封装,通过jsonify进行格式化返回
# restful_utils.py
from flask import jsonify
class HttpCode(object):
ok = 200
un_auth_error = 401
params_error = 400
server_error = 500
def restful_result(code, message, data):
return jsonify({"code": code, "message": message, "data": data or {}})
def success(message="", data=None):
"""
正确返回
:return:
"""
return restful_result(code=HttpCode.ok, message=message, data=data)
第 5 步,暴露接口
使用 flask_restful 中的 Api 实例对象,将上面定义的资源路由暴露出去
#api_app.py
from flask_restful import Api
api = Api(app)
# 某一条记录
api.add_resource(FooApi, '/api/v1/foo','/api/v1/foo/<int:id>')
# 所有记录
api.add_resource(FooListApi, '/api/v1/foos')
第 6 步,自动生成接口文档
Flask 中同样可以利用 Swagger 自动生成接口帮助文档
首先,从配置文件 config.py 中读取配置,实例化 Swagger 对象
#api_app.py
from flasgger import Swagger
# API可视化管理
swagger_config = Swagger.DEFAULT_CONFIG
# 标题
swagger_config['title'] = config.SWAGGER_TITLE
# 描述信息
swagger_config['description'] = config.SWAGGER_DESC
# Host
swagger_config['host'] = config.SWAGGER_HOST
# 实例化
swagger = Swagger(app,config=swagger_config)
然后,在资源路由的动作内新增 swagger 注释内容,包含:请求方式、参数、响应数据、描述信息等
具体可以参考:http://editor.swagger.io/#/
以获取某一条数据为例:
class FooApi(Resource):
resource_fields = {
'id': fields.Integer,
'name': fields.String,
'age': fields.String
}
@marshal_with(resource_fields)
def get(self, id):
"""获取用户信息
---
schemes:
- http
parameters:
- name: id
in: path
type: integer
required: true
default: 1
description: 用户id
responses:
200:
description: 返回用户信息
examples:
{
"id": 1,
"name": "xag",
"age":"18"
}
"""
foo = db.session.query(Foo).get(id)
return foo
最后,运行项目,访问下面的链接,即可以看到定义好的 RESTful API 服务了
http://localhost:5000/apidocs/#/
5. 最后
上面就是通过 Flask + flask_restful 单表实现 RESTful API 完整的流程了,项目中涉及的多表,只需要更改数据库的逻辑操作就可以了
相关推荐
- 推荐一款Python的GUI可视化工具(python 可视化工具)
-
在Python基础语法学习完成后,进一步开发应用界面时,就需要涉及到GUI了,GUI全称是图形用户界面(GraphicalUserInterface,又称图形用户接口),采用图形方式显示的计算机操...
- 教你用Python绘制谷歌浏览器的3种图标
-
前两天在浏览matplotlib官方网站时,笔者无意中看到一个挺有意思的图片,就是用matplotlib制作的火狐浏览器的logo,也就是下面这个东东(网页地址是https://matplotlib....
- 小白学Python笔记:第二章 Python安装
-
Windows操作系统的python安装:Python提供Windows、Linux/UNIX、macOS及其他操作系统的安装包版本,结合自己的使用情况,此处仅记录windows操作系统的python...
- Python程序开发之简单小程序实例(9)利用Canvas绘制图形和文字
-
Python程序开发之简单小程序实例(9)利用Canvas绘制图形和文字一、项目功能利用Tkinter组件中的Canvas绘制图形和文字。二、项目分析要在窗体中绘制图形和文字,需先导入Tkinter组...
- 一文吃透Python虚拟环境(python虚拟环境安装和配置)
-
摘要在Python开发中,虚拟环境是一种重要的工具,用于隔离不同项目的依赖关系和环境配置。本文将基于windows平台介绍四种常用的Python虚拟环境创建工具:venv、virtualenv、pip...
- 小白也可以玩的Python爬虫库,收藏一下
-
最近,微软开源了一个项目叫「playwright-python」,作为一个兴起项目,出现后受到了大家热烈的欢迎,那它到底是什么样的存在呢?今天为你介绍一下这个传说中的小白神器。Playwright是...
- python环境安装+配置教程(python安装后怎么配置环境变量)
-
安装python双击以下软件:弹出一下窗口需选择一些特定的选项默认选项不需要更改,点击next勾选以上选项,点击install进度条安装完毕即可。到以下界面,证明安装成功。接下来安装库文件返回电脑桌面...
- colorama,一个超好用的 Python 库!
-
大家好,今天为大家分享一个超好用的Python库-colorama。Github地址:https://github.com/tartley/coloramaPythoncolorama库是一...
- python制作仪表盘图(python绘制仪表盘)
-
今天教大家用pyecharts画仪表盘仪表盘(Gauge)是一种拟物化的图表,刻度表示度量,指针表示维度,指针角度表示数值。仪表盘图表就像汽车的速度表一样,有一个圆形的表盘及相应的刻度,有一个指针...
- 总结90条写Python程序的建议(python写作)
-
1.首先 建议1、理解Pythonic概念—-详见Python中的《Python之禅》 建议2、编写Pythonic代码 (1)避免不规范代码,比如只用大小写区分变量、使用容易...
- [oeasy]python0137_相加运算_python之禅_import_this_显式转化
-
变量类型相加运算回忆上次内容上次讲了是从键盘输入变量input函数可以有提示字符串需要有具体的变量接收输入的字符串输入单个变量没有问题但是输入两个变量之后一相加就非常离谱添加图片注释,不超过1...
- Python入门学习记录之一:变量(python中变量的规则)
-
写这个,主要是对自己学习python知识的一个总结,也是加深自己的印象。变量(英文:variable),也叫标识符。在python中,变量的命名规则有以下三点:>变量名只能包含字母、数字和下划线...
- 掌握Python的"魔法":特殊方法与属性完全指南
-
在Python的世界里,以双下划线开头和结尾的"魔法成员"(如__init__、__str__)是面向对象编程的核心。它们赋予开发者定制类行为的超能力,让自定义对象像内置类型一样优雅工...
- 11个Python技巧 不Pythonic 实用大于纯粹
-
虽然Python有一套强大的设计哲学(体现在“Python之禅”中),但总有一些情况需要我们“打破规则”来解决特定问题。这触及了Python哲学中一个非常核心的理念:“实用主义胜于纯粹主义”...
- Python 从入门到精通 第三课 诗意的Python之禅
-
导言:Python之禅,英文名是TheZenOfPython。最早由TimPeters在Python邮件列表中发表,它包含了影响Python编程语言设计的20条软件编写原则。它作为复活节彩蛋...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python字典遍历 (54)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (60)
- python读取文件夹下所有文件 (59)
- java调用python脚本 (56)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)