IT轮子系列（三）——如何给返回类型添加注释——Swagger的使用（二）

前言

一般对外提供API，都会统一一个返回类型，比如所有的接口都统一返回HttpResponseMessage。这样当我们在方法上添加///注释时，是无法清楚的知道都返回字段都又那些以及它们的数据类型是什么。如下图所生成的文档所示：

、

从图中，我们看到文档只有输入参数的说明，而对于返回的类型是什么，有那些字段都是不清楚的。这对于调用第三方调用是很不友好的。

在实际项目中，偶然发现，Swashbuckle 提供一个返回类型属性，很好的解决了这个问题。

如代码所示：

/// </summary>
    public class UserController : BaseController
    {
        /// <summary>
        /// 获取用户信息
        /// </summary>
        /// <param name="model">获取用户信息模型</param>
        /// <returns></returns>
        [HttpPost]
        //添加方法修饰属性返回类型说明
        [SwaggerResponse(HttpStatusCode.OK, Type = typeof(ResultInfo<UserInfo>))]
        public HttpResponseMessage GetUserInfo([FromBody]GetUserInfoModel model)
        {
            ResultInfo<UserInfo> result = new ResultInfo<UserInfo>();
            try
            {
                UserInfo user = new UserInfo();
                user.Name = "Peter";
                user.Phone = model.phone;
                user.Email = "itwheels@163.com";
                result.Data = user;
            }
            catch (Exception ex)
            {
                result.Status = "FAIL";
                result.Msg = ex.Message;
            }         
            
            return toJson(result);
        }
    }

当我们给方法添加SwaggerResponse属性修饰的时候，在生成的文档中就可以看到返回类型拉。