使用 Python 写一个友好的 API 还是很重要的

作者：小帅b

来源：学习Python的正确姿势

今天想跟你聊聊 RESTful API 这玩意，以及如何使用 Python 快速创建你的 API 给别人调用。

你应该经常去调用过 API ，通过一定的规则就能快速使用别人提供的服务，比如你想要使用人脸身份证比对，就有相应的 API 供你使用：

然后你只要调用这个接口就能快速实现：

返回结果：

这样做的好处就是，我们在后端只需要提供接口，然后前端不管是手机、PC、微信小程序等，都可以通过这个接口实现具体的功能，这样的话前后端就可以做到互不 “干涉”，分离部署都可以。

那么我们如何使用 Python 去实现类似这样的 API 接口，提供服务给别人使用呢？RESTful API 又是个什么鬼？

什么是 RESTful API？

虽然说 API 你可以自己定制，但是总不能写成类似这样的吧：

往往，前后端程序员的矛盾就此产生...

前端：

后端：

所以，写一个友好的 API 还是很重要的，而 RESTful API 就是一种流行且友好的风格，它主要用来约束 API 的写法，让别人使用起来能感到清晰，简洁，一目了然，使用方便。

像这样：

我们定义的 URI 需要清晰易于理解，例如：

 https://api.fxxkpython.com/shop/products/list 

这样我们一眼就能明白这是请求商品数据列表。

尽量通过 JSON 或者 XML 来传递数据对象和属性。

明确的使用 HTTP 方法（例如，get、post、put和delete）。

无状态，在请求的时候，服务端不存储客户端的上下文状态。

Python 如何创建 RESTful API？

相信你对 Python 的 web 框架有一定的了解：

（来自视频号：学习python的正确姿势）

而今天要给你介绍的是基于 Flask 框架写的轻量级额rest API 框架：FlaskRESTful ，它易于使用，写法和 Flask 类似，你也可以直接在你项目中的 ORM 层中使用它。

接下来一起看看官方提供的例子，简单演示一下它的使用。

导入相应的库，定义类资源，在里面可以使用 http 的 get 、put 方法定义接口，接着通过 api 添加资源即可轻松实现一个 API 接口：

运行起来：

访问：

刚说了，你只要定义好资源类，在里面可以写多个 http 的 get、put、post 等方法，比如这里你可以使用 put 来添加 data 数据到字典中：

在这里可以把请求路径的 todo_id 作为变量，运行起来后你就可以往里相应的 put 数据了：

使用 get 方法获取：

在 add_resource 中，你可以定义多个路由指向同一个类资源中去：

访问：

验证表单数据类型，可以使用 reqparse 定义 type：

这样当用户提交的不是 int 类型会直接返回错误信息：

当你的 API 想要返回一个对象的时候，可能你需要对对象中的参数定义好类型，可以使用 fields 和 marshal_with 进行装饰，像这样：

ok，以上就是 FlaskRESTful 的常用操作，更多参数信息可以到以下链接中查看：

https://flask-restful.readthedocs.io/en/latest/

你也可以试着就我们上次说的 用 Python 开发一个 【个人计划 todolist】 用 FlaskRESTful 改写一下，体会一下区别。

那么我们下回见咯，peace！

---------End---------

顺便给大家推荐下我的微信视频号「价值前瞻」，主要分享读书、成长和投资思考，可以了解不一样的我，欢迎扫码关注。