SwaggerUI删除显示错误参数的端点

时间:2019-05-29 12:20:02

标签: c# asp.net-web-api swagger swashbuckle

我的SwaggerUI显示的Delete Endpoint参数错误。我正在传递要删除的对象,但是在SwaggerUI中显示的参数是对象的ID。有办法纠正吗?

Api方法:

[SwaggerResponse(HttpStatusCode.OK)] public IHttpActionResult Delete([FromBody]CargoApiDTO cargoDto)

enter image description here

1 个答案:

答案 0 :(得分:0)

我确实认为我是否应该将其发布为答案,因为它不能直接回答问题。

话虽如此,我认为您正在以错误的方式进行此操作。 DELETE请求显然将删除请求传递给端点。因此,它不需要整个对象。

考虑一下您需要删除的内容,您所需要的就是您要删除的资源的唯一标识符。我猜Swagger试图为您指明正确的方向。

即使您传递了整个对象,最后您也只会从整个DTO中提取ID,这使得毫无意义地通过网络传输潜在的大量数据毫无意义。

因此,更改端点,仅将id作为参数,Swagger就不会再混淆了。