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

Posted 2023-02-19

【中文标题】RAML - 如何设计带有参数的端点？

【英文标题】：RAML - how to design endpoints with parameters?

【发布时间】：2021-02-05 00:06:02

【问题描述】：

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

Resource: quantity

Method: GET

URL: orderId/itemId/quantity

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

/orderId/itemId/quantity:
  get:

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

【参考方案1】：

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

/orders:
  /order_id:
    /items:
      /item_id:
        get:

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