0

API を文書化していますが、作成した ViewModel に応答形式をリンクする方法を考えています。ViewModel には、ユーザーに閲覧してもらいたい注釈があります。問題は、コントローラーが実際のモデル自体ではなくHttpResponseMessageを返すことです。そのため、WebAPI ヘルプ ページでは、これについての説明を省略しています。

API ヘルプ ページ

HelpPageConfig.cs に以下を追加しました。

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

これを回避し、APIExplorer を使用してヘルプ ページにリンクを作成するにはどうすればよいですか。または、これは手動で行う必要がありますか?

コントローラーの例。

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

1 に答える 1

3

最近導入されたResponseType属性を使用して、これを行う方法を見つけました。

 [HttpGet]
 [ResponseType(typeof(CourseModel))]
 public HttpResponseMessage GetById(string id)
 {
于 2014-04-23T10:57:33.477 に答える