action - 如何在 RAML 中为动作建模

Question

我想了解使用 RAML 对资源进行操作建模的最佳方法是什么。

例如，我在 RAML 中有以下资源定义：

/orders:
  type: collection
  get:
    description: Gets all orders
  post:
    description: Creates a new order

  /{orderId}:
    type: element
    get:
      description: Gets a order

    put:
      description: Updates a order

    delete:
      description: Deletes a order

现在对于一个订单，我想模拟一个“批准”动作。是否有使用 RAML 执行此操作的最佳实践？

Answer 1

• 您可以 PUT 或 PATCH 在模型中将某些“批准”设置为 true。

• 您可以将批准视为一种资源。例如：

  /orders:
    type: collection
    get:
    post:
    /{orderId}:
      type: element
      get:
      put:
      delete:
      /approval:
        post:
        get:
        ...
  

这不是 RAML 的最佳实践。它与您如何在 REST 中表示您的模型更相关。

Answer 2

您可以将PATCH 请求与“补丁文档”一起使用，该“补丁文档”会在订单上显示已批准的标志。