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 = "[e-mail]";
                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文檔中看到方法名拉。如下圖：