在使用Flask以及插件Flask-RESTful来开发RESTful API时,返回值和状态码的设计是非常重要的一个部分。对于初学者,在不使用response
或errorhandler()
等装饰器时,经常会向发来的请求直接返回需要的数据,比如在没有找到请求的数据时:
return None
这显然是最为简便的一种写法。但是当我们希望统一所有的返回值为JSON格式时,这里需要一些小小的改动(假设希望返回名为student
的数据):
return {'student': None}
这样我们就可以返回一个合法的以JSON表示的结果。
但是,这里还有一个小问题,虽然我们的本意是没有找到任何请求的数据,但返回码仍然是默认的200,这显然是不合理的,既容易造成误解也不利于之后的日志分析。因此,简单添加404即可:
return {'student': None}, 404
在此基础上还可以做一个灵活的拓展,假设我们根据发来的请求对数据库进行了检索,并将结果赋给名为student
的变量。如果搜索结果即最后的student
为空,则状态码为404,否则为200。比较pythonic的写法为:
return {'student': student}, 200 if student is not None else 404