如何在RAML 1.0中描述原始文件体？

Question

我有一个API端点，允许用户上传文件，请求有效负载是原始文件内容。我如何在RAML文档中对此进行描述？

我使用suck结构，但对我来说似乎不正确

post:
  description: Use this endpoint to upload a new image.
  headers:
    X-File-Name: Image file name.
  body:
    file:
    description: Send raw file contents in a request payload

感谢。

Answer 1

在RAML 1中，您可以使用文件类型：

types:
  customFile:
    type: file
    fileTypes: ['*/*'] # any file type allowed
    maxLength: 1048576

然后像这样使用它：

/someresource:
  post:
    body:
      application/octet-stream:
        type: customFile