raml - RAML - 如何设计带有参数的端点？

Question

我需要使用 RAML 设计此规范：

Resource: quantity

Method: GET

URL: {orderId}/{itemId}/quantity

目标是在URI中传递orderId和itemId并获取数量。我是这样设计的：

/{orderId}/{itemId}/quantity:
  get:

以这种方式设计资源是最佳实践还是有更好的方法？

Answer 1

通过将订单和商品之间的关系作为集合和个人数据提供，这样的事情会更加 RESTful：

/orders:
  /{order_id}:
    /items:
      /{item_id}:
        get:

quantity应该是响应正文中的一个字段。