Как определить ответ «image/jpeg» в RAML?

Question

Я определяю API с использованием RAML, и мне нужно вернуть изображение (а не как JSON). Какой-либо специальный намек на то, как выставить метод «контент» в моем API?

/images/{imageId}: 
    get: 
    responses: 
     200: 
     body: 
      application/json: 

... 
/images/{imageId}/content: 

Answer 1

Для Raml 1 вы можете использовать file type, например:

... 
types: 
    userPicture: 
    type: file 
    fileTypes: ['image/jpeg'] 
    maxLength: 307200 

... 
/images/{imageId}: 
    get: 
    responses: 
     200: 
     body: 
      image/jpeg: 
      type: userPicture 

For RAML 0.8 the file type is only aplicable to formParameters.

Но вы все еще можете использовать тип носителя, например:

/images/{imageId}: 
    get: 
    responses: 
     200: 
     body: 
      image/jpeg: 
      description: an image...