Блог

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

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

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

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

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

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

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