Flask-RESTful 是一个优秀的 Flask 扩展，可以方便地构建 REST API 接口。在编写 REST API 时，经常需要将数据格式化成 JSON 或者其它格式返回给客户端。Flask-RESTful 的 marshal_with 装饰器非常方便地将返回的数据格式化成指定的格式。
然而，在实际开发中，可能会遇到 marshal_with 装饰器无效的情况。本文将介绍这种情况的原因以及解决方案。
问题描述
当使用 Flask-RESTful 的 marshal_with 装饰器时，返回给客户端的数据没有按照装饰器指定的格式进行格式化。例如，考虑以下代码：
-- -------------------- ---- -------
---- ------------- ------ ---- --------- ------- ------------
--- - ---------------
--- - --------
--------------- - -
------- --------------
------ --------------
-
----- -----------------
------------------------------
--- ----------
------ -------- -------- ------ ---
------------------------ ----------此时，访问 /person 接口，返回的数据应该是 {'name': 'Alice', 'age': 25}。然而，实际上返回的是原始数据 {'name': 'Alice', 'age': 25}。这时，marshal_with 装饰器就无法实现预期效果。
原因分析
导致 marshal_with 装饰器无效的原因通常是将 Flask-RESTful 和 Flask 的功能混合使用。如上述代码片段中，在 Flask 应用程序中使用 Flask-RESTful 提供 API，但是没有在 Flask 的应用程序对象上注册 Flask-RESTful API 对象。因此，导致 marshal_with 装饰器不能正常工作。
解决方案
为了解决 marshal_with 装饰器无效的问题，正确的做法是在 Flask 的应用程序对象上注册 Flask-RESTful API 对象。
代码示例：
-- -------------------- ---- -------
---- ----- ------ -----
---- ------------- ------ ---- --------- ------- ------------
--- - ---------------
--- - --------
--------------- - -
------- --------------
------ --------------
-
----- -----------------
------------------------------
--- ----------
------ -------- -------- ------ ---
------------------------ ----------
-- -------- -- -----------
---------在上述代码片段中，先创建 Flask 应用程序对象，然后创建 Flask-RESTful API 对象。注册 API 对象后，将其用作 add_resource 方法的参数。通过这种方法，使 marshal_with 装饰器能够正常工作，生成指定的数据格式。
总结
Flask-RESTful 是一个很强大的工具，使用它可以有效地构建 RESTful API 接口。在使用装饰器 marshal_with 时，如果发现无法正常工作，需要检查是否正确将 Flask-RESTful API 对象注册到 Flask 的应用程序对象上。只有正确地使用 Flask-RESTful 才能更好地利用它提供的功能，提高 API 开发效率和代码可维护性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64ab958748841e98947656b9