rest - 使用 IHttpActionResult 时，如何获取帮助文档以在 WebApi2 中工作？

Question

我想利用 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);
    }

但是当我这样做时，我会丢失/Help/Api/GET-2013-12-05-user-id 下自动生成的 api 文档的一部分。

这是丢失的文档部分:

响应体格式

应用程序/json，文本/json

样本:

{
"url": "示例字符串 1",
“数据”: {
“身份证”:1，
"adUserName": "示例字符串 2",
"name": "示例字符串 3",
“defaultRoutingGroupId”:4
},
"errorLevel": "示例字符串 2",
"errorMessage": "示例字符串 3"
}

Answer 1

您可以使用“ResponseType”属性装饰操作，HelpPage 会选择它以生成示例...

示例:[ResponseType(typeof(UserModel)]