Документ pdf/двоичный ответ в RAML

Question

В настоящее время я пишу документацию для api, которая возвращает json или pdf (двоичный) на основе Accept-Header, отправленного в систему.

Как я могу указать, что ответ имеет тип двоичный или аналогичный?

Answer 1

В спецификации RAML я нашел type: file, который, кажется, был тем, что я искал. См. https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#file

Answer 2

Вам нужно будет определить возможные ответы, как показано ниже.

responses: 
    200: 
     body: 
     application/octet-stream: 
     ....... 
     application/json: 
     ........ 

Кроме того, вы также можете указать заголовок ACCEPT с перечислением возможных типов содержимого.

 headers: 
     Accept: 
       type: string 
       enum: [application/octet-stream, application/json] 
      required: true