带有 dotnet core 的 Swagger 文档的文件返回类型

Question

我正在使用 Swagger for dotnet core 记录我的 dotnet 核心 Web API。

我已阅读文档告诉我需要添加 [ProducesResponseType(typeof(XXXXX),200)]上面的控制器方法，帮助swagger判断方法的响应类型。

我有一个返回文件的控制器方法，我正在尝试弄清楚如何告诉 swagger 我正在返回一个文件。

public class DocumentController : Controller
{
    private readonly IDocumentService _documentService;

    public DocumentController(IDocumentService documentService)
    {
        _documentService = documentService;
    }

    [HttpGet("{documentId}", Name= DocumentRoutes.Document)]
    [ProducesResponseType(typeof(XXXXX), 200)] // <== What goes here?
    public async Task<IActionResult> GetDocument(Guid documentId)
    {
        DocumentAdto documentAdto = await _documentService.GetAsync(documentId);
        return File(documentAdto.DocumentBytes, documentAdto.ContentType, documentAdto.Name);
    }
}

有人有什么想法吗？

我考虑过 byte[] 但这只是说返回类型是“byte”。

Answer 1

您需要的是ProducesAttribute 并指定内容类型作为参数（例如，PDF 文件的“application/pdf”）。

编辑：看起来 Swagger 可能无法接受 ProducesAttribute。然后我的建议是不要为ProducesResponseType 设置Type，并在方法中添加/// <response code="200">Returns the requested file</response> 注释。