记录API模型响应模型

时间:2014-04-22 15:13:25

标签: c# asp.net-web-api asp.net-web-api-helppages

我正在记录API,并且我想知道如何将响应格式链接到我创建的ViewModel。 ViewModel具有我希望用户浏览的注释。作为我的控制器的问题是返回 HttpResponseMessage 而不是实际的模型本身,因此WebAPI帮助页面会跳过对此进行记录;

API Help page

在HelpPageConfig.cs中,我添加了以下内容;

config.SetSampleResponse(xmloutput.ToString(), new MediaTypeHeaderValue("text/xml"), 
   "Course", "Get", new[] { "Id" });

如何解决此问题,并使用API​​Explorer在“帮助”页面中创建链接。或者这必须手动完成吗?

示例控制器;

[HttpGet]
public HttpResponseMessage Get(string id)        {
   var obj = new Course(id);
   return this.Request.CreateResponse<Course>(HttpStatusCode.OK, obj);
}

1 个答案:

答案 0 :(得分:3)

我已经了解了如何执行此操作,最近引入了ResponseType属性;

 [HttpGet]
 [ResponseType(typeof(CourseModel))]
 public HttpResponseMessage GetById(string id)
 {