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

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...