大佬教程收集整理的这篇文章主要介绍了swagger的作用和配置使用,大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。
在学习net core中接触到了swagger、学习并记录
纯API项目中 引入swagger可以生成可视化的API接口页面
nuget包: Swashbuckle.AspNetCore(最新稳定版)
1.配置Startup类Configureservices方法的相关配置
1 public void Configureservices(IserviceCollection services) 2 { 3 //swagger服务配置 4 services.AddSwaggerGen(c => 5 { 6 c.SwaggerDoc("V1", new Microsoft.openApi.Models.OpenApiInfo 7 { 8 Version = "v1",//接口文档版本 9 title = "我的接口文档1.0",//接口文档标题 10 Description = "我的第一个swagger文档",//接口文档描述 11 Contact = new Microsoft.openApi.Models.OpenApiContact { Name = "张华", Url = new Uri("http://baidu.com"), Email = "nice0320@163.com" }, 12 License = new Microsoft.openApi.Models.OpenApiLicense { Name = "张华", Url = new Uri("http://baidu.com") } 13 }); 14 }); 15 services.AddControllers(); 16 }
2.配置Startup类Configure方法的中间件
1 public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 2 { 3 if (env.IsDevelopment()) 4 { 5 app.UseDeveloperExceptionPage(); 6 } 7 8 app.UseRoutIng(); 9 10 app.UseAuthorization(); 11 12 app.UseEndpoints(endpoints => 13 { 14 endpoints.MapControllers(); 15 }); 16 17 ///swagger中间件启动配置 18 app.UseSwagger(); 19 app.UseSwaggerUI(a => { 20 a.SwaggerEndpoint("/swagger/V1/swagger.json", "中间件启动配置,我的第一个swagger文档"); 21 //如果是为空 访问路径就为 根域名/index.html,注意localhost:8001/swagger是访问不到的 22 //路径配置,设置为空,表示直接在根域名(localhost:8001)访问该文件 23 // c.RoutePrefix = "swagger"; // 如果你想换一个路径,直接写名字即可,比如直接写c.RoutePrefix = "swagger"; 则访问路径为 根域名/swagger/index.html 24 a.RoutePrefix = String.Empty;//路由 25 }); 26 }
新建项目第一次配置完成运行的时候可能如下所示。因为 /WeatherForecast 是官方默认的地址
解决方案:Properties文件夹下launchsetTings.json文件launchUrl属性改为null
launchUrl代表浏览器里启动相对的URL
以上是大佬教程为你收集整理的swagger的作用和配置使用全部内容,希望文章能够帮你解决swagger的作用和配置使用所遇到的程序开发问题。
如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。