10分钟，带你用Python构建RESTful API 服务

1. 前言

上一篇文章，介绍了使用 Java + Spring Boot + MyBatis 构建 RESTful API 的详细步骤；很多小伙伴表示，更愿意用 Python 编写 RESTful API 服务，希望我能写一下

本篇将以 Python 开始介绍搭建 RESTful API 的流程 ，使用的技术栈是：Flask + flask-restful + flasgger

2. 安装依赖

使用 Python 编写 RESTful API 之前，我们需要先在虚拟环境内安装对应的依赖

3. Hello World

首先，我们使用 Pycharm 创建一个 Flask Web 项目，初始化代码如下：

从 flask_restful 文件中导入 Api、Resource 两个类，使用上面的 app 对象，构建一个 api 对象，接着准备一个列表数据

}]

然后，利用 Flask 中的 CBV 模式，创建一个 Resource 类的子类，用于定义资源路由

这里以 GET / POST 动作为例，重写 get、post 方法，并编写内部逻辑，返回数据即可

]}

最后，使用 Api 的实例对象，将上面定义的资源，利用路径，完全暴露出去

运行程序后，就可以拿 Postman 或 cURL 去测试接口了

4. 项目实战

在实际项目开发中，数据结构、层级关系往往要复杂很多，我们需要对项目进行一次整合，按功能进行封装，具体步骤如下：

第 1 步，编写配置文件

新建一个配置文件 config.py，将数据库（ 以 Mysql 为例 ）的连接信息，包含：用户名、密码、端口号、数据库名、连接驱动和 Swagger 的设置信息追加进去

第 2 步，模型映射数据库

创建一个模型类 Foo 继承 SQLAlchemy 对象，使用  __tablename__ 指定生成数据表的名称、然后新增几个常用字段

    age = db.Column(db.INTEGER)

接着，创建 manage.py 文件

显式导入上面创建的 Foo 类，使用 flask_migrate 中的 Migrate 绑定 App 和数据库，利用 flask_script 中的 Manager 实例去添加一个脚本命令

    manager.run()

需要注意的是，Foo 模型必须显式导入，否则没法映射到数据库中

最后，通过下面 3 个脚本命令，将模型映射到数据库中

除了第一次需要生成迁移脚本外，后面映射数据库，只需要执行后面两个命令即可

打开 Navicat For Mysql，即可以看到刚刚映射过来的数据表及迁移表

第 3 步，创建资源路由

下面以创建列表查询（ GET ）、单条记录的查询（ GET ）、更新（ PUT ）、新增（ POST ）、删除（ DELETE ）为例

flask_restful 中的 marshal_with 类可以作为装饰器，定义到动作函数上，指定要返回的字段；然后使用 SQLAlchemy ORM 操作数据库，将数据直接进行返回

比如：返回获取数据列表

 foos

对于新增一个对象（ POST 动作）

)

第 4 步，返回数据统一化

为了保证返回的数据结构一致，可以将返回码、返回信息及数据进行一次封装，通过jsonify进行格式化返回

 restful_result(code=HttpCode.ok, message=message, data=data)

第 5 步，暴露接口

使用 flask_restful 中的 Api 实例对象，将上面定义的资源路由暴露出去

)

第 6 步，自动生成接口文档

Flask 中同样可以利用 Swagger 自动生成接口帮助文档

首先，从配置文件 config.py 中读取配置，实例化 Swagger 对象

然后，在资源路由的动作内新增 swagger 注释内容，包含：请求方式、参数、响应数据、描述信息等

具体可以参考：http://editor.swagger.io/#/

以获取某一条数据为例：

最后，运行项目，访问下面的链接，即可以看到定义好的 RESTful API 服务了

http://localhost:5000/apidocs/#/

5. 最后

上面就是通过 Flask + flask_restful 单表实现 RESTful API 完整的流程了，项目中涉及的多表，只需要更改数据库的逻辑操作就可以了

我已经将文中全部源码上传到后台，关注后回复「 rest 」即可获得全部源码

<p style="margin-right: 8px;margin-left: 8px;letter-spacing: 0.544px;"><br  /></p><p style="margin-right: 8px;margin-left: 8px;letter-spacing: 0.544px;"><span style="font-size: 15px;color: rgb(255, 41, 65);"><strong>近期热门：</strong></span></p><ul class="list-paddingleft-2"><li><section style="margin-right: 8px;margin-left: 8px;letter-spacing: 0.544px;line-height: 1.75em;"><span style="font-size: 15px;text-decoration: underline;"><strong><span style="color: rgb(0, 0, 0);">Github获8300颗星，<strong style="white-space: pre-wrap;color: rgb(63, 63, 63);letter-spacing: 0.544px;"></strong><strong style="white-space: pre-wrap;color: rgb(63, 63, 63);letter-spacing: 0.544px;">用Python开发的命令行版网易云音乐</strong></span>！</strong></span></section></li><li><section style="margin-right: 8px;margin-left: 8px;letter-spacing: 0.544px;line-height: 1.75em;"><span style="font-size: 15px;text-decoration: underline;"><strong>这个微信神器厉害了，必须安利<br  /></strong></span></section></li><li><section style="margin-right: 8px;margin-left: 8px;letter-spacing: 0.544px;line-height: 1.75em;"><span style="font-size: 15px;text-decoration: underline;"><strong>学Python还是Java, 7张漫画带你全面分析<br  /></strong></span></section></li><li><section style="margin-right: 8px;margin-left: 8px;letter-spacing: 0.544px;line-height: 1.75em;"><span style="font-size: 15px;text-decoration: underline;">太赞了！Python学习宝典，GitHub标星3.9K！223个小例子，一次让你吃个够！<br  /></span></section></li></ul>

<pre style="letter-spacing: 0.544px;line-height: inherit;"><section data-mpa-template="t" mpa-from-tpl="t"><section data-id="94086" data-color="#276ca3" data-tools="135编辑器" mpa-from-tpl="t"><section><section mpa-from-tpl="t"><section style="text-align: center;"><br  /></section><p style="text-align: center;"><br  /></p><p style="text-align: left;letter-spacing: 0.544px;line-height: inherit;color: rgb(63, 63, 63);word-spacing: 1px;font-size: 16px;widows: 1;font-family: "Helvetica Neue", Helvetica, "Hiragino Sans GB", "Microsoft YaHei", Arial, sans-serif;"><span style="font-size: 15px;">由菜鸟学Python原班人马打造的：【程序员GitHub】 ，现已上线。</span></p></section></section></section></section>