我们使用 .NET WebAPI 框架,并在 Web API 之上使用 swagger 来进行注释和开箱即用的 UI 体验。到目前为止,它运行得很好。但是,当我从 WebAPI(Http 400) 返回错误时,代码如下:
return BadRequest("Some error");
但是,当我这样做时,Swagger 似乎无法正确解析错误。基本上,显示response 0
。这肯定是错误的,因为当我去Chrome DevTools
,我看到我的请求响应为 HTTP 400,正如我所预期的那样。
如何配置 Swagger 才能正确显示错误?或者我应该以稍微不同的方式抛出我的错误,以便能够大摇大摆地看到它?
你可以这样注释你的动作
[ProducesResponseType(typeof(ResponseObjectTypeHere), 200)]
[ProducesResponseType(typeof(ErrorResponseObjectTypeHere), 400)]
如果启用 swagger 来读取和使用 xml 文档,您还可以在 xml 文档中添加类似的内容
/// <response code="200">Description</response>
/// <response code="400">Description of error</response>
我在 .net core web api 项目中使用了 swagger,对于常规 .net web api 项目也应该是相同的。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)