基于HttpResponseMessage中内容类型的Web Api文档

时间:2015-11-06 09:46:20

标签: c# xml asp.net-web-api documentation

我正在构建一个WebApi,我想为它创建文档。

我的大多数方法都应该以格式返回数据:{errorCode:200, errorMessage:'msg', data:[item1{}, item2{}, ...]}

所以我为它创建了一个'ResponseDTO'类并添加了一个摘要。如果在控制器方法中我返回:return new ResponseDTO(201, "Test", someData); ASP.NET将为我创建一个很好的标准文档。

但实际上我想要返回这样的内容:return Request.CreateResponse<ResponseDTO>(HttpStatusCode.OK, response);。在这种情况下,ASP.Net创建了一个关于HttpResponseMessage的文档。

我可以让ASP.Net创建有关我在CreateResponse<T>中指定的类型的文档吗?

1 个答案:

答案 0 :(得分:1)

我找到了我正在寻找的内容:[ResponseType(typeof(ResponseDTO))]

感谢:http://www.strathweb.com/