Как сообщить веб-API ApiExplorer, что конечная точка будет возвращать двоичные данные (например, ZIP-файл)?

Question

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

/// <summary>
/// returns the specified Foo.
/// </summary>
[ResponseType(typeof(FooModel))]
[HttpGet]
[Route("~/api/foos/{fooId}")]
public async Task<IHttpActionResult> GetFoo(int fooId)
{
    ...
}

Это сделает красивую запись на странице справки Api, описывающую поведение конечной точки.

Я хочу документально подтвердить, что определенная конечная точка будет возвращать двоичный поток application/zip. Как я могу это сделать?

Answer 1

Ну, если вы уже знаете, что ваша конечная точка API будет возвращать zip-файл, вы можете установить его жестко application/octet-stream,

content-type = "application/octet-stream"