• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

asp.netcoreApi配置swagger

原作者: [db:作者] 来自: [db:来源] 收藏 邀请

这个很简单的一篇文章用来记录以下使用swagger的过程,以后有用。

1.nuget 下载install-package Swashbuckle.AspNetCore

2.startup里面configureservice配置:

 services.AddSwaggerGen(c =>
            {
                //添加document,这个主要用来在swaggerUI页面上面显示一些额外的信息
                //注意第一个参数"pangjianxin"这个参数要和startup中configure方法中的
                //c.SwaggerEndpoint("/swagger/pangjianxin/swagger.json", "My API V1");保持一致,否则swagger会报错。
                c.SwaggerDoc("pangjianxin", new Info
                {

                    Version = "v12",
                    Title = "api列表",
                    Description = "一个简单的api列表",
                    TermsOfService = "None",
                    Contact = new Contact
                    {
                        Name = "庞建新",
                        Email = "[email protected]",
                        Url = "https://www.baidu.com"
                    },
                    License = new License
                    {
                        Name = "no license",
                        Url = "https://www.baidu.com"
                    }
                });
                //添加读取controller中action注释的作用,但是要首先在项目属性==》生成==》勾选XML选项,并记住名字,在这里用。
                var basePath = PlatformServices.Default.Application.ApplicationBasePath;
                var xmlPath = Path.Combine(basePath, "Api.xml");
                c.IncludeXmlComments(xmlPath);
            });

3.在startup中configure配置:

             //在添加swagger并将其作为json端点配置到中间件管道上
            app.UseSwagger();

            //配置swaggerUI的中间件,并指定上述配置的json端点
            app.UseSwaggerUI(c =>
            {
//配置swagger的json端点 c.SwaggerEndpoint("/swagger/pangjianxin/swagger.json", "My API V1"); //RoutePrefix,路由前缀,赋值strig.Empty说明点击网站根目录就可以进入swaggerUI c.RoutePrefix = string.Empty; });

 然后就没有然后了 

 


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap