6

我在RAML中声明了一个 REST 服务 API 存根。我的web应用提供了设备，可以列出，可以通过id或者code获取。当我想要整个列表时，我不指定任何 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）中传递的参数添加说明。有没有办法实现它？

4

1 回答 1

8

您缺少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 -参数

于 2014-09-24T13:56:30.127 回答