描述RAML中的URI参数

Question

我正在声明RAML中的REST服务API存根。我的网络应用程序提供可以列出的设备，可以通过ID或代码获得。当我想要整个列表时，我没有指定任何URI参数，但是，我需要一个具体的设备。这是它的当前状态：

/equipment: 
    get: 
     body: 
     application/json: 
     application/xml: 
    description: 
     List all the equipment 
    /id/{equipmentId}: 
     get: 
     body: 
      application/json: 
      application/xml: 
     description: 
     Get an equipment by id 
    /code/{code}: 
     get: 
      body: 
      application/json: 
      application/xml: 
     description: 
       Get an equipment by code 

在这里，在description字段我写什么目前的调用执行。但是，我想为在URI中传递的参数添加说明（id或code）。有没有办法实现它？

Answer 1

您错过了uriParameters部分来描述equipmentId和code参数。在此部分中，您可以指定平常：type，description ...

见部分模板URI和URI参数在规范：https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md#template-uris-and-uri-parameters