什么是 RESTful API
RESTful API 是一种基于 HTTP/HTTPS 协议实现的 API 设计风格，它的核心思想是将服务器上的资源以 URL 的形式暴露出来，客户端可以通过 HTTP 动词（GET、POST、PUT、DELETE 等）对这些资源进行操作。RESTful API 的设计风格具有简洁、灵活、可扩展、可维护等优点，因此在 Web 开发中得到了广泛的应用。
Flask 简介
Flask 是一款轻量级的 Python Web 框架，它的设计理念是简单而灵活，可以快速开发出高效的 Web 应用。Flask 支持多种扩展，可以满足不同应用场景的需要，同时也提供了对 RESTful API 的支持。
在 Flask 中实现 RESTful API 的关键是定义好 URL 和 HTTP 动词之间的映射关系，这一过程可以通过 Flask-RESTful 扩展来简化。Flask-RESTful 提供了多个类和方法，可以方便地定义 API 资源和对应的 HTTP 动词操作。
安装 Flask-RESTful
要使用 Flask-RESTful，需要先安装它：
--- ------- -------------
定义 API 资源
在 Flask-RESTful 中，API 资源是指服务器上的某个具体的数据或操作，可以用一个类来表示。在这个类中，可以定义该资源支持的 HTTP 动词操作（GET、POST、PUT、DELETE 等），每个操作对应一个方法。
下面是一个简单的示例，定义了一个 TodoList 资源，支持 GET（获取所有 Todo）、POST（添加新的 Todo）和 DELETE（删除所有 Todo）操作：
---- ------------- ------ --------
----- -------------------
--- ----------
- ---- ----
----
--- -----------
- ---- ----
----
--- -------------
- ---- ----
----定义 URL 和 HTTP 动词之间的映射关系
在 Flask-RESTful 中，可以通过 Api 类来将 API 资源和 URL 之间建立映射关系，使用 add_resource() 方法来添加映射关系。该方法需要传入两个参数，第一个参数是 API 资源类，第二个参数是 URL。
下面是一个示例，将 TodoList 资源映射到 /todos 路径下：
---- ------------- ------ --- --- - --------------- --- - -------- -------------------------- ---------
定义 HTTP 动词操作
在 API 资源类中，可以定义对应的 HTTP 动词操作。在 Flask-RESTful 中，可以使用装饰器来定义操作。例如，使用 @api.representation() 装饰器来定义 GET 操作的返回格式：
---- ------------- ------ ---- --------- ------- ------------
----------- - -
----- ---------------
------- --------------
------- --------------
-
----- -------------------
- ---- ----
--------------------------
--- ----------
----- - --
- ---- ----
------ -----
- ---- ----
--------------------------
--- -----------
- ---- ----
------ ----
- ---- ----
--- -------------
- ---- ----
----在上面的示例中，使用 @marshal_with() 装饰器来指定 GET 和 POST 操作的返回格式。todo_fields 是一个字典，定义了 Todo 对象的属性和对应的数据类型。
运行 Flask 应用
定义好 API 资源和 URL 和 HTTP 动词之间的映射关系后，需要运行 Flask 应用。可以使用 app.run() 方法来运行 Flask 应用：
-- -------- -- -----------
-------------------测试 API
在浏览器中输入 http://localhost:5000/todos，可以看到返回的数据格式符合上面定义的 todo_fields。
总结
利用 Flask 实现 RESTful API 是一种简单而灵活的方式，可以快速开发出高效的 Web 应用。在 Flask-RESTful 的帮助下，可以方便地定义 API 资源和对应的 HTTP 动词操作。通过本文的学习，相信读者已经可以掌握 Flask-RESTful 的基本用法，可以在实际开发中灵活应用。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/6634b25bd3423812e4231b06