提交.Net6版本

2026-03-04 00:35:47 +08:00 · 2021-12-25 14:50:54 +08:00
parent aebf12a7ca
commit 6503ad905b
443 changed files with 17839 additions and 712 deletions
--- a/Yi.Framework.Net6/Yi.Framework.WebCore/MiddlewareExtend/SwaggerExtension.cs
+++ b/Yi.Framework.Net6/Yi.Framework.WebCore/MiddlewareExtend/SwaggerExtension.cs
@@ -0,0 +1,124 @@
+using IGeekFan.AspNetCore.Knife4jUI;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Mvc.Controllers;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.OpenApi.Models;
+using System;
+using System.IO;
+using Yi.Framework.Common.Models;
+
+namespace Yi.Framework.WebCore.MiddlewareExtend
+{
+    /// <summary>
+    /// Swagger扩展
+    /// </summary>
+    public static class SwaggerExtension
+    {
+        public static IServiceCollection AddSwaggerService<Program>(this IServiceCollection services, string title = "Yi意框架-API接口")
+        {
+            var apiInfo = new OpenApiInfo
+            {
+                Title = title,
+                Version = "v1",
+                Contact = new OpenApiContact { Name = "橙子", Email = "454313500@qq.com", Url = new System.Uri("https://ccnetcore.com") }
+            };
+            #region 注册Swagger服务
+            services.AddSwaggerGen(c =>
+            {
+                c.SwaggerDoc("v1", apiInfo);
+
+                //添加注释服务
+                //为 Swagger JSON and UI设置xml文档注释路径
+                //获取应用程序所在目录(绝对路径，不受工作目录影响，建议采用此方法获取路径使用windwos&Linux）
+                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
+                var apiXmlPath = Path.Combine(basePath, @"SwaggerDoc.xml");//控制器层注释
+                //var entityXmlPath = Path.Combine(basePath, @"SwaggerDoc.xml");//实体注释
+                //c.IncludeXmlComments(apiXmlPath, true);//true表示显示控制器注释
+                c.IncludeXmlComments(apiXmlPath,true);
+
+                //添加控制器注释
+                //c.DocumentFilter<SwaggerDocTag>();
+
+                //添加header验证信息
+                //c.OperationFilter<SwaggerHeader>();
+                //var security = new Dictionary<string, IEnumerable<string>> { { "Bearer", new string[] { } }, };
+
+                c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme()
+                {
+                    Description = "文本框里输入从服务器获取的Token。格式为：Bearer + 空格+token",//JWT授权(数据将在请求头中进行传输) 参数结构: \"Authorization: Bearer {token}\"
+                    Name = "Authorization",////jwt默认的参数名称
+                    In = ParameterLocation.Header,////jwt默认存放Authorization信息的位置(请求头中)
+                    Type = SecuritySchemeType.ApiKey,
+                });
+                c.AddSecurityRequirement(new OpenApiSecurityRequirement
+                {
+                    { new OpenApiSecurityScheme
+                    {
+                        Reference = new OpenApiReference()
+                        {
+                            Id = "Bearer",
+                            Type = ReferenceType.SecurityScheme
+                        }
+                    }, Array.Empty<string>() }
+                });
+
+                c.AddServer(new OpenApiServer()
+                {
+                    Url = "https://ccnetcore.com",
+                    Description = "Yi-Framework"
+                });
+                c.CustomOperationIds(apiDesc =>
+                {
+                    var controllerAction = apiDesc.ActionDescriptor as ControllerActionDescriptor;
+                    return controllerAction.ActionName;
+                });
+            });
+            #endregion
+
+            return services;
+        }
+
+        public static void UseSwaggerService(this IApplicationBuilder app, params SwaggerModel[] swaggerModels)
+        {
+            //在 Startup.Configure 方法中，启用中间件为生成的 JSON 文档和 Swagger UI 提供服务：
+            // Enable middleware to serve generated Swagger as a JSON endpoint.
+            app.UseSwagger();
+
+
+            app.UseKnife4UI(c =>
+            {
+                c.RoutePrefix = "swagger"; // serve the UI at root
+                if (swaggerModels.Length == 0)
+                {
+                    c.SwaggerEndpoint("/v1/swagger.json", "Yi.Framework");
+                }
+                else
+                {
+                    foreach (var k in swaggerModels)
+                    {
+                        c.SwaggerEndpoint(k.url, k.name);
+                    }
+                }
+            });
+
+            //app.UseSwaggerUI(c =>
+            //{
+            //    if (swaggerModels.Length == 0)
+            //    {
+            //        c.SwaggerEndpoint("/swagger/v1/swagger.json", "Yi.Framework");
+            //    }
+            //    else
+            //    {
+            //        foreach (var k in swaggerModels)
+            //        {
+            //            c.SwaggerEndpoint(k.url, k.name);
+            //        }
+            //    }
+
+            //}
+
+            //);
+        }
+
+    }
+}