c# - 如何告诉 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"