使用dotnet核心的Swagger文檔的返回類型

Question

我使用Swagger for dotnet core來記錄我的dotnet核心Web API。

我已閱讀文檔，告訴我需要在控制器方法上方添加 [ProducesResponseType(typeof(XXXXX),200)]以幫助確定方法的響應類型。

我有一個控制器方法，返回一個文件，我想解決如何我可以告訴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 []，但只是說返回類型是「字節」。

Answer 1

您需要的是ProducesAttribute並指定內容類型作爲參數（例如PDF文件的「application/pdf」）。

編輯：它似乎Swagger可能不拿起ProducesAttribute。我的建議是將Type取消設置爲ProducesResponseType，併爲該方法添加/// <response code="200">Returns the requested file</response>註釋。