如何告诉Web 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帮助页面上成为一个不错的条目，描述了此端点的行为。

我想记录某个端点将返回应用程序/ZIP二进制流。我该怎么做？

Answer 1

好吧，如果您已经知道您的API端点将返回zip文件，则可以将其硬编码为application/octet-stream。

content-type = "application/octet-stream"