IT轮子系列（三）——如何显示方法名——Swagger的使用（三）

前言

在上一篇文章IT轮子系列（三）——如何给返回类型添加注释——Swagger的使用（二） 介绍如何使用swashbuckle的时候忽略了一个问题，就是默认创建的API项目在生成文档的时候是没有显示方法名，只显示了控制器的名字。如下图：

User 控制器代码如下：

    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);
        }
    }

按照代码，我们想要的显示方法名GetUserInfo。今天在写另一篇API相关文章，才发现这个问题。经过一份琢磨，发现swashbuckle 是根据我们在路由配置WebApiConfig中的模版来生成的。如，默认的配置代码为：

 config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );

所以，按照这个配置生成的文档只显示了控制器的名字，却没有方法名。

解决方案

按照上面分析的思路，要在swagger文档中显示接口的方法名，只需修改路由模版就可以了。修改后的代码如下：

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{action}"
            );

这样修改后，我们就可以在swagger文档中看到方法名拉。如下图：