烧瓶 - 宁静的嵌套资源

时间:2014-08-31 20:11:47

标签: python rest flask-restful

我重构我的其余api服务器以使用Flask-RESTful,我对某些特定情况有一些疑问,我需要获取属于另一个的资源列表。有点像这样:

/api/v1/users/john/orders

你会如何设计?因为如果我有一个名为Orders的资源,我需要知道从哪个用户获得订单。但是我怎样才能让资源了解用户呢?我没有看到任何__ init __方法,我可以在其中指定资源的参数。

在注册订单资源时我想过做这样的事情:

api.add_resources(Orders, '/api/v1/users/<string:username>/orders')

但是如何在Orders资源中访问字符串:username

我想一个解决方案就是:

api.add_resources(Orders, '/api/v1/orders/') 

并发送查询参数,指定我想要获取订单的用户,但我想知道是否可以执行类似上述示例的操作。

1 个答案:

答案 0 :(得分:6)

好吧,我终于明白了。这是解决方案

假设我们有一个可以按名称查看的用户端点,并且用户也可以查询订单。订单查询将是一个通用的东西,它只需要相应的查询参数,并需要知道它将在哪个用户查找订单:

from flask import Flask
from flask_restful import Api


app = Flask(__name__)
app.config['DEBUG'] = True

from views import *

api = Api(app)
api.add_resource(OrdersQuery, '/api/v1/user/<string:name>/orders/query/')

定义资源类时:

class OrdersQuery(Resource):
    def get(self, name):
        ## do something with name, like retrieving the user
        ## probably grab the orders and apply the query with the params from the url
        return jsonify({
            'result_list': [..something in here..]
        })

如您所见,您正在使用URL的可变部分(用户名)作为查询订单端点。