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页面了。

相关内容

热门资讯

不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...
【NI Multisim 14...   目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限:此外...
北信源内网安全管理卸载 北信源内网安全管理是一款网络安全管理软件,主要用于保护内网安全。在日常使用过程中,卸载该软件是一种常...
​ToDesk 远程工具安装及... 目录 前言 ToDesk 优势 ToDesk 下载安装 ToDesk 功能展示 文件传输 设备链接 ...
AWSECS:访问外部网络时出... 如果您在AWS ECS中部署了应用程序,并且该应用程序需要访问外部网络,但是无法正常访问,可能是因为...
报告实验.pdfbase.tt... 这个错误通常是由于找不到字体文件或者文件路径不正确导致的。以下是一些解决方法:确认字体文件是否存在:...
APK正在安装,但应用程序列表... 这个问题可能是由于以下原因导致的:应用程序安装的APK文件可能存在问题。设备上已经存在同名的应用程序...
AWSElasticBeans... 在Dockerfile中手动配置nginx反向代理。例如,在Dockerfile中添加以下代码:FR...