Определения заголовков Swagger

Question

Я не могу найти, можно ли объявить объект заголовка, чтобы повторно использовать его в заголовках ответов, есть примеры, определяющие объекты для схем ответа, но они не переносятся в заголовки ответов. Я только успел сделать многоразовый объект ответа, как это:

responses: 
    DownloadOk: 
    description: Dowload Ok 
    headers: 
     Content-Length: 
     description: response length 
     type: integer 
     Document-Length: 
     description: document length 
     type: integer 

Но, как я уже сказал, я хотел бы сохранить только часть заголовка.

Вот где я хотел бы использовать:

responses: 
    200: 
     description: Dowload Ok 
     headers: 
     $ref: '#/definitions/DowloadOk' 

Answer 1

Согласно Swagger/OpenAPI спецификации вы не можете. Definitions должен содержать Schema Objects, и они не допускают произвольные свойства, но конкретное подмножество схемы JSON (см. the link).

Вы смогли определить Response Object и ссылаться на это, поскольку Swagger Object имеет глобальное свойство responses. Нет такой вещи для заголовков. Во всяком случае, в это время. Можно было бы запросить такую ​​функцию.

Answer 2

Я столкнулся с той же проблемой. В документе они заявляют;

Обратите внимание, что в настоящее время спецификация OpenAPI не позволяет определять общие заголовки ответов для разных кодов ответов или разных операций API. Вы должны определить заголовки для каждого ответа индивидуально.

см Заголовок раздел ответа на Describing Responses.