Question

我在 RAML 中声明了一个REST服务API存根。我的Web应用程序提供了可以列出的设备，可以通过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

在RAML中描述URI参数

1 个答案: