ASP.NET Core - Swagger - 公共和私有Swagger页面
创始人
2024-09-14 12:31:00
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页面了。

相关内容

热门资讯

避免在粘贴双引号时向VS 20... 在粘贴双引号时向VS 2022添加反斜杠的问题通常是由于编辑器的自动转义功能引起的。为了避免这个问题...
安装apache-beam==... 出现此错误可能是因为用户的Python版本太低,而apache-beam==2.34.0需要更高的P...
Android Recycle... 要在Android RecyclerView中实现滑动卡片效果,可以按照以下步骤进行操作:首先,在项...
安装了Anaconda之后找不... 在安装Anaconda后,如果找不到Jupyter Notebook,可以尝试以下解决方法:检查环境...
omi系统和安卓系统哪个好,揭... OMI系统和安卓系统哪个好?这个问题就像是在问“苹果和橘子哪个更甜”,每个人都有自己的答案。今天,我...
原生ios和安卓系统,原生对比... 亲爱的读者们,你是否曾好奇过,为什么你的iPhone和安卓手机在操作体验上有着天壤之别?今天,就让我...
Android - 无法确定任... 这个错误通常发生在Android项目中,表示编译Debug版本的Java代码时出现了依赖关系问题。下...
Android - NDK 预... 在Android NDK的构建过程中,LOCAL_SRC_FILES只能包含一个项目。如果需要在ND...
Akka生成Actor问题 在Akka框架中,可以使用ActorSystem对象生成Actor。但是,当我们在Actor类中尝试...
Agora-RTC-React... 出现这个错误原因是因为在 React 组件中使用,import AgoraRTC from “ago...