我希望利用WebApi2和IHttpActionResult的自动化文档功能。因此,我想更改以下代码段:
/// <summary>
/// Gets specified User
/// </summary>
/// <param name="id">User Id</param>
/// <returns>The user</returns>
public UserModel Get(int id)
{
UserModel result = new UserModel()
{
ErrorLevel = "Warning",
ErrorMessage = "Not Implemented yet!"
};
User u = new User() { Id = 1, ADUserName = "nfindlater", DefaultRoutingGroupId = 1 };
result.Data = u;
var helper = new UrlHelper(Request);
result.Url = helper.Link("User", new { userId = 1 });
return result;
}
/// <summary>
/// Gets specified User
/// </summary>
/// <param name="id">User Id</param>
/// <returns>The user</returns>
public IHttpActionResult Get(int id)
{
UserModel result = new UserModel()
{
ErrorLevel = "Warning",
ErrorMessage = "Not Implemented yet!"
};
User u = new User() { Id = 1, ADUserName = "nfindlater", DefaultRoutingGroupId = 1 };
result.Data = u;
var helper = new UrlHelper(Request);
result.Url = helper.Link("User", new { userId = 1 });
return Ok<UserModel>(result);
}
但是,当我这样做时,我会失去自动生成的API文档的一部分,位于 /Help/Api/GET-2013-12-05-user-id。
以下是被遗失的文档部分:
响应主体格式
application/json, text/json 示例:
{ "url": "示例字符串1", "data": { "id": 1, "adUserName": "示例字符串2", "name": "示例字符串3", "defaultRoutingGroupId": 4 }, "errorLevel": "示例字符串2", "errorMessage": "示例字符串3" }