要在 .NET Core 中使用 IGeekFan.AspNetCore.Knife4jUI,您可以按照以下步驟進(jìn)行配置:
-
首先,安裝 IGeekFan.AspNetCore.Knife4jUI NuGet 包??梢酝ㄟ^ Visual Studio 的 NuGet 包管理器或者 .NET CLI 進(jìn)行安裝。
-
在 Startup.cs 文件的 ConfigureServices 方法中,添加以下代碼,來配置 IGeekFan.AspNetCore.Knife4jUI:文章來源:http://www.zghlxwxcb.cn/news/detail-639250.html
builder.Services.AddSwaggerGen(c =>
{
// 配置 Swagger 文檔相關(guān)信息
c.SwaggerDoc("v1", new OpenApiInfo { Title = "API Documentation 123", Version = "v1" });
// 配置 Swagger 生成的 XML 文檔 【這樣可是接口的注釋展示出來】
// 在項(xiàng)目屬性中啟用 XML 文檔生成。右鍵點(diǎn)擊項(xiàng)目,選擇 "屬性",在 "生成" 選項(xiàng)卡中勾選 "啟用生成 XML 文檔文件",并指定生成的 XML 文件的路徑。請(qǐng)注意確保該 XML 文件存在,并與程序集名稱一致。
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath);
// 可以在這里添加其他 Swagger 相關(guān)配置,例如添加身份驗(yàn)證信息等
});
- 在 Configure 方法中,確保在其他中間件之前啟用 IGeekFan.AspNetCore.Knife4jUI:
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
// app.UseSwaggerUI();
app.UseKnife4UI(c =>
{
c.RoutePrefix = string.Empty;
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Your API V2");
});
}
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
這樣就完成了 IGeekFan.AspNetCore.Knife4jUI 的配置。您可以在啟動(dòng)應(yīng)用程序后,訪問 https://localhost:7089/index.html#/home
(具體地址取決于您的應(yīng)用程序配置)來查看生成的 Swagger UI。文章來源地址http://www.zghlxwxcb.cn/news/detail-639250.html
到了這里,關(guān)于.net core的Knife4jUI,讓swagger更精致的文章就介紹完了。如果您還想了解更多內(nèi)容,請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!