C# 搭建Swagger项目

搭建Swagger项目步骤:

1.文件-->新建-->项目-->ASP.NET Web应用程序  使用VS2017进行搭建

2.选择WebAPI,点击确定

3.打开NuGet管理器搜索并安装Swashbuckle、Swagger.Net、Swagger.Net.UI三项。

4.右键应用程序  选择属性-->生成,勾选XML文档文件,Ctrl+S(注意XML文档文件名,后面需要配置)

5.配置SwaggerConfig 文件,每项配置都有注释,请自行查看(注意XML解析与第4步文件名对应)

        /// <summary>
        ///  应用程序启动的时候调用 PreApplicationStartMethod
        /// </summary>
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        //指定版本以及 主页面标题
                        c.SingleApiVersion("v1", "SwaggerInterFace");

                        //添加XML解析
                        c.IncludeXmlComments(string.Format(@"{0}\bin\Swagger.XML",
          System.AppDomain.CurrentDomain.BaseDirectory));

                    })
                //原本进入swagger的地址是/swagger/ui/index 这样就能换地址成/Swagger/index 
                .EnableSwaggerUi("Swagger/{*assetPath}"
            ,       c =>{
                             //设置标题
                            c.DocumentTitle("SwaggerApis");
                        });
        }

注释SwaggerNet文件应用启动执行方法,这里我们使用webApi的路由配置这里可不需要SwaggerNet的路由

6.访问路径(IP:端口/配置路由),即可看到如下页面

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值