你如何在RAML中建模一个动作

Question

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

E.g。我在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

现在我要订购一个＆＃34;批准＆＃34;行动。是否有使用RAML执行此操作的最佳做​​法？

Answer 1

• 你可以PUT或PATCH设置一些＆＃34; Approval＆＃34;在你的模特中为真。

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

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

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

Answer 2

您可以使用带有“补丁文档”的PATCH request来提高订单上的已批准标记。