ASP.NET Core - Swagger - 公共和私有Swagger页面
创始人
2024-09-14 12:31:41
0

要在ASP.NET Core中使用Swagger,首先需要安装Swagger NuGet包。在项目的.csproj文件中,添加以下代码:


  

然后,在Startup.cs文件中配置Swagger中间件和生成Swagger文档的选项。在ConfigureServices方法中添加以下代码:

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "API", Version = "v1" });
});

在Configure方法中添加以下代码:

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1");
    c.RoutePrefix = string.Empty; // 将Swagger UI设置为应用程序的根路径
});

上述代码将Swagger UI设置为公共页面,可以通过浏览器访问根路径来查看API文档。

如果你想要添加私有Swagger页面,可以使用SwaggerUIOptions配置,将Swagger UI设置为需要身份验证的页面。在Configure方法中添加以下代码:

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1");
    c.RoutePrefix = "api/docs"; // 设置Swagger UI的路径为“api/docs”
    c.DisplayRequestDuration(); // 显示请求持续时间
    c.InjectStylesheet("/swagger-ui/custom.css"); // 添加自定义样式
    c.IndexStream = () => GetType().Assembly.GetManifestResourceStream("MyNamespace.index.html"); // 添加自定义HTML模板
    c.DocumentTitle = "My API Documentation"; // 设置Swagger UI的标题
});

上述代码将Swagger UI设置为需要身份验证的私有页面,并进行了一些自定义配置。

这样,你就可以在ASP.NET Core中使用Swagger,并根据需要设置公共和私有Swagger页面了。

相关内容

热门资讯

保存时出现了1个错误,导致这篇... 当保存文章时出现错误时,可以通过以下步骤解决问题:查看错误信息:查看错误提示信息可以帮助我们了解具体...
汇川伺服电机位置控制模式参数配... 1. 基本控制参数设置 1)设置位置控制模式   2)绝对值位置线性模...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
本地主机上的图像未显示 问题描述:在本地主机上显示图像时,图像未能正常显示。解决方法:以下是一些可能的解决方法,具体取决于问...
不一致的条件格式 要解决不一致的条件格式问题,可以按照以下步骤进行:确定条件格式的规则:首先,需要明确条件格式的规则是...
表格中数据未显示 当表格中的数据未显示时,可能是由于以下几个原因导致的:HTML代码问题:检查表格的HTML代码是否正...
表格列调整大小出现问题 问题描述:表格列调整大小出现问题,无法正常调整列宽。解决方法:检查表格的布局方式是否正确。确保表格使...
Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限:此外...
【NI Multisim 14...   目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...