WEB API 配置 Swagger

Swagger

Swagger作为一个在线文档，通过后端的接口控制器生成一套Json串数据，实时展示后端的接口请求地址，参数，类型以及回调，很好的解决这个问题（

工具->NuGet包管理器->管理解决方案的NuGet程序包...
在浏览中查找"Swashbuckle.AspNetCore"，选择项目工程，点击安装。

在Startup.cs文件ConfigureServices中，加入以下代码：

        public void ConfigureServices(IServiceCollection services)         {             services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);             #region Swagger             services.AddSwaggerGen(options =>             {                 options.SwaggerDoc("v1", new Info                 {                     Version = "v1.1.0",                     Title = "WebAPI",                     Description = "测试swagger",                 });                  // 为 Swagger JSON and UI设置xml文档注释路径                 var basePath = Path.GetDirectoryName(AppContext.BaseDirectory);//获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径）                 var xmlPath = Path.Combine(basePath, "DemoTest.xml");                 options.IncludeXmlComments(xmlPath);              });             #endregion         }

 

在Startup.cs类里Configure方法，加入以下代码：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)         {            …                         #region Swagger             app.UseSwagger();             app.UseSwaggerUI(options =>             {                 options.SwaggerEndpoint("/swagger/v1/swagger.json", "Web API Help V1");             });             #endregion              app.UseHttpsRedirection();             app.UseMvc();         }

　右键当前项目属性,选择生成栏目

 写好控制器看效果

 生成项目查看,浏览器输入端口号//swagger/index.html

 

　

　

来源：博客园

作者：洛洛&罗罗

链接：https://www.cnblogs.com/876878958-/p/11563168.html