第10章Swagger自定义实现index.html页-创新互联

1 初始化index.html页

复制原程序“index.html”页的内容到当前程序员“index.html”页。

注意：是内容复制，如果是页面替换复制，则必须重新把“index.html”页的属性中的“生成操作”设定为：“嵌入的资源”。

2 自定义SwaggerSetup依赖注入中间件

using Common.GlobalVar;

using Common.Helper;

using log4net;

using Microsoft.Extensions.DependencyInjection;

using Microsoft.OpenApi.Models;

using Swashbuckle.AspNetCore.Filters;

using System.Runtime.InteropServices;

using static Extensions.ServiceExtensions.CustomApiVersion;

namespace Extensions.ServiceExtensions

{

  ///

  ///

  /// 摘要：

  ///     通过AddSwaggerGen依赖注入中间，获取Api控制器方法的版本控制信息和注释等数据信息，依赖注入.Net7框架的内置容器中，为在“index.html”页面上渲染显示这些信息，作好预处理操作。

  ///

  public static class SwaggerSetup

  {

  #region 变量--私有/保护----静态

  ///

  private static readonly ILog log = LogManager.GetLogger(typeof(SwaggerSetup));

  #endregion

  #region 方法--静态

  ///.Net(Core)框架内置依赖注入容器实例。

  ///

  ///

  /// 摘要：

  ///     通过AddSwaggerGen依赖注入中间，获取Api控制器方法的版本控制信息和注释等数据信息，依赖注入.Net7框架的内置容器中，为在“index.html”页面上渲染显示这些信息，作好预处理操作。

  ///

  public static void AddSwaggerSetup(this IServiceCollection services)

  {

  if (services == null) throw new ArgumentNullException(nameof(services));

  var basePath = AppContext.BaseDirectory;

  //var basePath2 = Microsoft.DotNet.PlatformAbstractions.ApplicationEnvironment.ApplicationBasePath;

  var ApiName = AppSettings.app(new string[] { "Startup", "ApiName" });

  services.AddSwaggerGen(c =>

  {

  //遍历出全部的版本，做文档信息展示

  typeof(ApiVersions).GetEnumNames().ToList().ForEach(version =>

  {

  c.SwaggerDoc(version, new OpenApiInfo

  {

  Version = version,

  Title = $"{ApiName} 接口文档——{RuntimeInformation.FrameworkDescription}",

  Description = $"{ApiName} HTTP API " + version,

  Contact = new OpenApiContact { Name = ApiName, Email = "Blog.Core@xxx.com", Url = new Uri("https://neters.club") },

  License = new OpenApiLicense { Name = ApiName + " 官方文档", Url = new Uri("http://apk.neters.club/.doc/") }

  });

  c.OrderActionsBy(o =>o.RelativePath);

  });

  c.UseInlineDefinitionsForEnums();

  try

  {

  //这个就是刚刚配置的xml文件名

  var xmlPath = Path.Combine(basePath, "WebApi.xml");

  //默认的第二个参数是false，这个是controller的注释，记得修改

  c.IncludeXmlComments(xmlPath, true);

  //这个就是Model层的xml文件名

  var xmlModelPath = Path.Combine(basePath, "Blog.Core.Model.xml");

  c.IncludeXmlComments(xmlModelPath);

  }

  catch (Exception ex)

  {

  log.Error("WebApi.xml和Blog.Core.Model.xml 丢失，请检查并拷贝。\n" + ex.Message);

  }

  //Nuget--Swashbuckle.AspNetCore.Filters

  // 开启加权小锁

  c.OperationFilter();

  c.OperationFilter();

  // 在header中添加token，传递到后台

  c.OperationFilter();

  // ids4和jwt切换

  if (Permissions.IsUseIds4)

  {

  //接入identityserver4

  c.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme

  {

  Type = SecuritySchemeType.OAuth2,

  Flows = new OpenApiOAuthFlows

  {

  Implicit = new OpenApiOAuthFlow

  {

  AuthorizationUrl = new Uri($"{AppSettings.app(new string[] { "Startup", "IdentityServer4", "AuthorizationUrl" })}/connect/authorize"),

  Scopes = new Dictionary{

  {

  "blog.core.api","ApiResource id"

  }

  }

  }

  }

  });

  }

  else

  {

  // Jwt Bearer 认证，必须是 oauth2

  c.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme

  {

  Description = "JWT授权(数据将在请求头中进行传输) 直接在下框中输入Bearer {token}（注意两者之间是一个空格）\"",

  Name = "Authorization",//jwt默认的参数名称

  In = ParameterLocation.Header,//jwt默认存放Authorization信息的位置(请求头中)

  Type = SecuritySchemeType.ApiKey

  });

  }

  });

  //Nuget--Swashbuckle.AspNetCore.Newtonsoft

  services.AddSwaggerGenNewtonsoftSupport();

  }

  #endregion

  }

  ///

  public class CustomApiVersion

  {

  ///

  public enum ApiVersions

  {

  ///

  V1 = 1,

  ///

  V2 = 2,

  }

  }

}

3 重构Program类

//通过AddSwaggerGen依赖注入中间，获取Api控制器方法的版本控制信息和注释等数据信息，依赖注入.Net7框架的内置容器中，为在“index.html”页面上渲染显示这些信息，作好预处理操作。

builder.Services.AddSwaggerSetup();

builder.Services.AddControllers();

按F5执行程序，在执行登录操作后，即可跳转到自定义的“index.html”面，如上图所示

对以上功能更为具体实现和注释见：221202_09Blog(Swagger自定义实现index.html页)。

你是否还在寻找稳定的海外服务器提供商？创新互联www.cdcxhl.cn海外机房具备T级流量清洗系统配攻击溯源，准确流量调度确保服务器高可用性，企业级服务器适合批量采购，新人活动首月15元起，快前往官网查看详情吧