Dot-Net

Swagger 錯誤 用於操作的模糊 HTTP 方法 操作需要顯式 HttpMethod 綁定

  • June 29, 2022

我正在嘗試為我的 API 生成 swagger 文件。每次我導航到招搖文件時，我都會收到此錯誤：

用於操作的模棱兩可的 HTTP 方法 -

$$ ControllerName $$控制器.下載文件。操作需要 Swagger/OpenAPI 3.0 的顯式 HttpMethod 綁定

這是它在我的控制器中抱怨的“違規”程式碼：

   using Models;
using Utilities;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using System;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;


namespace Controllers
{
   [Route("api/[controller]")]
   [ApiController]
   public class LibrarianController : ControllerBase
   {
       private IFileUploadUtilties fileUtilities;
       private IConfiguration config;
       private ApiContext context;
       private IFileRetrieval fileRetrieval;
       public LibrarianController(IFileUploadUtilties utilities, IConfiguration config, FinwiseApiContext context, IFileRetrieval fileRetrieval)
       {
           fileUtilities = utilities;
           this.config = config;
           this.context = context;
           this.fileRetrieval = fileRetrieval;
       }

      [HttpGet]
       public IActionResult Get()
       {
           return Ok("Ok");
       }

       // GET api/<LibrarianController>/5
       [HttpGet("/api/[controller]/{Id}")]
       public async Task<IActionResult> Get(int id)
       {
           try
           {
               return Ok(await fileRetrieval.GetFileForPartnerItemById(id));
           }
           catch(Exception ex)
           {
               return NotFound();
           }
           
       }
       [HttpGet ("/api/[controller]/[action]/{fileId}")]
       public async Task<IActionResult> DownloadFile(int fileId)
       {
           if (fileId == 0)
               return Content("File Id missing");

           var fileDownload = await fileRetrieval.GetFileForPartnerItemById(fileId);
           var contentType = await fileUtilities.GetFileType(Path.GetExtension(fileDownload.NewFileName));

           var path = Path.Combine(config.GetSection("StoredFilePath").Value, fileDownload.NewFileName);

           var memory = new MemoryStream();
           using (var stream = new FileStream(path, FileMode.Open))
           {
               await stream.CopyToAsync(memory);
           }
           memory.Position = 0;
           return File(memory, contentType, Path.GetFileName(path));
       }

       [HttpGet("api/[controller]/{PartnerId}/{ItemId}")]
       public async Task<List<FileUploads>> GetFiles(string PartnerId, string ItemId)
       {
           var getFiles =  await fileRetrieval.GetAllFilesForPartnerItem(PartnerId, ItemId);
           return getFiles;
       }
       
       
       // POST api/<LibrarianController>
       [HttpPost]
       public async Task<IActionResult> Post([FromForm] FileInformation fileInfo)
       {
           int newFileVersion = 1;

           if (fileInfo == null || fileInfo.Files == null || fileInfo.Files.Count == 0)
               return BadRequest("File(s) not found");

           try
           {
               foreach (var locFile in fileInfo.Files)
               {
                   //check for file extension, if not there, return an error
                   var fileExtension = Path.GetExtension(locFile.FileName);
                   if (string.IsNullOrEmpty(fileExtension))
                       return BadRequest("Files must include file extension");


                   var valid = await fileUtilities.IsFileValid(locFile);

                   var newFileName = string.Concat(Guid.NewGuid().ToString(),valid.fileExtension);

                   var newFileLocation = Path.Combine(config.GetSection("StoredFilePath").Value, newFileName);
                  

                   if (!valid.FileExtensionFound)
                   {
                       return BadRequest($"Error {valid.FileExtensionFoundError}");
                   }
                   if (!valid.FileSizeAllowed)
                   {
                       return BadRequest($"Error: {valid.FileSizeAllowedError}");
                   }


                   //check for an existing file in the database.  If there is one, increment the file version before the save
                   var currentFile = await fileUtilities.FileExists(fileInfo, locFile);

                   if (currentFile != null)
                   {
                       newFileVersion = currentFile.Version + 1;
                   }
             
                   //save to the file system
                   using (var stream = new FileStream(newFileLocation, FileMode.OpenOrCreate, FileAccess.ReadWrite))
                   {
                       await locFile.CopyToAsync(stream);
                   }

                   //save to the db.  Check to see if the file exists first.  If it does, do an insert, if not, return an error
                   if (System.IO.File.Exists(newFileLocation))
                   {
                       FileUploads upload = new FileUploads
                       {
                           EntityId = fileInfo.EntityId,
                           FileName = locFile.FileName,
                           ItemId = fileInfo.ItemId.ToString(),
                           NewFileName = newFileName,
                           ValidFile = true,
                           Version = newFileVersion
                       };
                       context.FileUploads.Add(upload);
                       context.SaveChanges();
                       //TODO: fire event the file has been saved provide Id key to find the record
                       //upload.Id;
                   }
                   else
                   {
                       return BadRequest("Error: File Could not be saved");
                   }

               }
           }
           catch (Exception ex)
           {
               return BadRequest("Failure to upload files.");
           }
           return Ok("File Uploaded");
       }

       // PUT api/<LibrarianController>/5
       [HttpPut("{id}")]
       public void Put(int id, [FromBody] string value)
       {
       }

       // DELETE api/<LibrarianController>/5
       [HttpDelete("{id}")]
       public void Delete(int id)
       {
       }
   }
}

當我測試它時，這個端點工作正常。我設置了路由，它用 HTTP 裝飾，所以我不明白它在抱怨什麼。我環顧四周尋找解決方案，但據我所知，它表明控制器中沒有修飾的公共方法，但是該控制器中沒有未修飾的方法。這裡有什麼問題？如果我從 HttpGet 中刪除路由資訊，則無法訪問該方法，因此我需要同時擁有 Route 和 HttpGet 裝飾器才能訪問此方法（除非我也做錯了）。我怎樣才能解決這個問題？

為什麼模棱兩可

這是您的路由DownloadFile()：

[HttpGet ("/api/[controller]/[action]/{fileId}")]
public async Task<IActionResult> DownloadFile(int fileId)

這是一個GetFiles()：

[HttpGet("api/[controller]/{PartnerId}/{ItemId}")]
public async Task<List<FileUploads>> GetFiles(string PartnerId, string ItemId)

考慮一個 GET 請求/api/Librarian/DownloadFile/62959061。此網址適合兩種操作：

  • 對於DownloadFile(), DownloadFile是62959061是. [action]_fileId
  • 對於GetFiles(), DownloadFile是62959061是. PartnerId_ （.NET在進行模型綁定時會將62959061視為字元串。）ItemId

這就是為什麼你有模棱兩可的錯誤。

建議

為每個操作分配一個唯一的名稱和可預測的路線。

1.方法名重複

而不是這些：

public IActionResult Get() { /*...*/ }
public async Task<IActionResult> Get(int id) { /*...*/ }

重命名方法之一以避免相同的方法名稱：

public IActionResult Get() { /*...*/ }
public async Task<IActionResult> GetById(int id) { /*...*/ }

2. 定義獨特的路線

形成您定義的控制器，我建議您[RoutePrefix]在控制器級別使用並使用[Route]或[Http{Method}]在操作級別。這是關於它們是什麼的相關討論。

使用相同的模式定義路由可以避免意外創建模糊路由。以下是我重新定義路由的嘗試：

[RoutePrefix("api/[controller]")] // api/Librarian
[ApiController]
public class LibrarianController : ControllerBase
{
   [HttpGet("")] // GET api/Librarian/
   public IActionResult Get() { /*...*/ }

   [HttpGet("{Id}")] // GET api/Librarian/62959061
   public async Task<IActionResult> GetById(int id) { /*...*/ }

   [HttpGet("download/{fileId}")] // GET api/Librarian/download/62959061
   public async Task<IActionResult> DownloadFile(int fileId) { /*...*/ }

   [HttpGet("getfiles/{PartnerId}/{ItemId}")] // GET api/Librarian/getfiles/partnerid/itemid
   public async Task<List<FileUploads>> GetFiles(string PartnerId, string ItemId) { /*...*/ }

   [HttpPost("")] // POST api/Librarian/
   public async Task<IActionResult> Post([FromForm] FileInformation fileInfo) { /*...*/ }

   [HttpPut("{id}")] // PUT api/Librarian/62959061
   public void Put(int id, [FromBody] string value) { /*...*/ }

   [HttpDelete("{id}")] // DELETE api/Librarian/62959061
   public void Delete(int id) { /*...*/ }
}

通過添加路徑，DownloadFile()應用GetFiles()程序應該能夠正確辨識路線，因為應用程序知道所有必須去的路線和必須/download去的DownloadFile()所有路線。/getfiles``GetFiles()

[NonAction]我通過在不是端點的函式的標頭中包含簽名來解決我的問題

例子

[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiController]
public class RequestController : ControllerBase {

   [NonAction]
   public ObjectResult SetError( Exception e)
   {
       return StatusCode(500, e.Message);
   }
}

引用自：https://stackoverflow.com/questions/62959061

相關問答

Asp.net-Mvc

Swagger 不為 IActionResult 包裝的對像生成模型

  • February 2, 2022
檢視問答
Dot-Net

.Net Core appsettings.json 最佳實踐 - 覆蓋開發設置（反之亦然）？

  • January 26, 2022
檢視問答
Dot-Net-Core

.Net Core 3.1 刪除 Swagger UI 上的架構

  • September 26, 2021
檢視問答
Dot-Net

將參數與 EntityFramework 和 FromSql 一起使用

  • August 24, 2021
檢視問答
Dot-Net

FileLoadException：無法載入文件或程序集 System.Runtime，版本 = 4.2.0.0

  • August 18, 2021
檢視問答
Asp.net-Core

虛擬目錄中的 IIS 站點 Swagger UI 端點

  • July 26, 2021
檢視問答