using Microsoft.AspNetCore.Builder;
using Swashbuckle.AspNetCore.SwaggerUI;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WIDESEA_Core.Helper;
namespace WIDESEA_Core.Middlewares
{
///
/// Swagger中间件
///
public static class SwaggerMiddleware
{
///
/// 配置应用程序使用Swagger中间件
///
/// 应用程序构建器
/// 用于获取自定义Swagger首页HTML流的函数
///
/// 此扩展方法配置Swagger UI,包括:
/// 1. 设置API文档端点
/// 2. 自定义文档标题和样式
/// 3. 配置自定义首页流
/// 4. 设置文档展开行为和路由前缀
/// 如果streamHtml返回null,将抛出异常提示需要将index.html设置为嵌入资源
///
public static void UseSwaggerMiddle(this IApplicationBuilder app, Func streamHtml)
{
if (app == null) throw new ArgumentNullException(nameof(app));
app.UseSwagger();
app.UseSwaggerUI(c =>
{
//根据版本名称倒序 遍历展示
var apiName = AppSettings.Get(new string[] { "ApiName" });
c.SwaggerEndpoint($"/swagger/v1/swagger.json", $"{apiName} v1");
// 将swagger首页,设置成我们自定义的页面,记得这个字符串的写法:{项目名.index.html}
if (streamHtml.Invoke() == null)
{
var msg = "index.html的属性,必须设置为嵌入的资源";
//Log.Error(msg);
throw new Exception(msg);
}
c.DocumentTitle = $"{apiName} 在线调试文档";
c.InjectStylesheet("/css/swaggerdoc.css");
c.InjectJavascript("/js/swaggerdoc.js");
c.IndexStream = streamHtml;
c.DocExpansion(DocExpansion.None); //->修改界面打开时自动折叠
// 路径配置,设置为空,表示直接在根域名(localhost:8001)访问该文件,注意localhost:8001/swagger是访问不到的,去launchSettings.json把launchUrl去掉,如果你想换一个路径,直接写名字即可,比如直接写c.RoutePrefix = "doc";
c.RoutePrefix = "";
});
}
}
}