隐藏

.Net Core中ProducesResponseType的作用

发布:2022/12/28 17:35:42作者:管理员 来源:本站 浏览次数:636



当我们写的接口已IActionResult为返回类型的时候,我们会发现swagger的Responses下并没有为我们生成返回信息描述,因为它并不知道我们具体要返回的是什么形式的数据


例如,我们新写一个分页接口:



   


   我们可以看到没有任何的返回信息描述,那怎么办呢?这里我们就要用到swagger的ProducesResponseType特性来告诉swagger我们的返回结构



   再次启动调试,我们发现在Responses这一模块已经正确显示了我们的PageList描述信息。


细心的可能会发现我们在使用ProducesResponseType的时候除了给了它一个type,还给了一个200,这是啥意思呢?


这个200的意思就是响应状态200的时候我给你返回这么一个结构的数据,那是不是说我们可以定义不同响应状态不同数据结构呢?答案是肯定的。ProducesResponseType是可以多次标记的,你只需要为其他状态按照上边的方式添加返回结构标记即可