使用Swashbuckle生成Web API Help Pages

 使用Swashbuckle生成Web API Help Pages 

 1.新增WebApi项目

 

2.利用Swashbuckle生成Web API Help Pages

管理NuGet程序包

搜索swagger，找到Swashbuckle并下载

下载后，项目App_Start中会添加一个SwaggerConfig.cs文件，如下图：

修改项目启动后的默认入口

启动查看效果

扫描二维码关注公众号，回复： 5997898 查看本文章

新增测试控制器后，重新启动项目，查看浏览器效果

/// <summary>
    /// 测试控制器
    /// </summary>
    [RoutePrefix("api")]
    public class TestController : ApiController
    {
        /// <summary>
        /// 测试Get API
        /// </summary>
        /// <param name="name">名称</param>
        /// <returns></returns>
        [Route("GetTest")]
        [HttpGet]
        public IHttpActionResult GetTest(string name)
        {
            return Json(new { Data="返回测试数据"});
        }
        /// <summary>
        /// 测试POST API
        /// </summary>
        /// <param name="data">数据</param>
        [Route("PostTest")]
        [HttpPost]
        public void PostTest(string data)
        {
        }
    }

设置将备注内容一并显示

1.右键打开启动项目属性

2.勾上生成XML文档文件

3.打开SwaggerConfig，取消 c.IncludeXmlComments(GetXmlCommentsPath());的注释，并创建一个GetXmlCommentsPath方法

private static string GetXmlCommentsPath()
        {
            return Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "bin",
                string.Format("{0}.XML", typeof(SwaggerConfig).Assembly.GetName().Name));
        }

4.重新启动项目后，查看浏览器效果