休息 – 使用IHttpActionResult时如何获取帮助文档在WebApi2中工作?

前端之家收集整理的这篇文章主要介绍了休息 – 使用IHttpActionResult时如何获取帮助文档在WebApi2中工作?前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
我想利用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,DefaultRoutingGroupId = 1 };
        result.Data = u;

        var helper = new UrlHelper(Request);
        result.Url = helper.Link("User",new { userId = 1 });

        return Ok<UserModel>(result);
    }

但是当我这样做时,我放松了/ Help / Api / GET-2013-12-05-user-id下自动生成的api文档的一部分.

以下是丢失的文档的一部分:

响应体格式

application / json,text / json

样品:

{
“url”:“sample string 1”,
“data”:{
“id”:1,
“adUserName”:“sample string 2”,
“name”:“sample string 3”,
“defaultRoutingGroupId”:4
},
“errorLevel”:“sample string 2”,
“errorMessage”:“sample string 3”
}

解决方法

您可以使用“ResponseType”属性来装饰动作,并且HelpPage会选择此操作来生成示例…

示例:[ResponseType(typeof(UserModel)]

猜你在找的asp.Net相关文章