117笔记问答要更新ASP.NET Swagger，请按照以下步骤操作：
- 确保已安装Swashbuckle.AspNetCore包。如果没有，请在项目中使用以下命令安装：
dotnet add package Swashbuckle.AspNetCore
-
打开项目中的
Startup.cs文件。 -
在
Startup.cs文件中，找到ConfigureServices方法。确保在此方法中调用了AddSwaggerGen方法。例如：
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews();
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
}
- 在
Configure方法中，找到UseSwagger和UseSwaggerUI方法。确保它们位于UseRouting和UseEndpoints之间。例如：
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
}
else
{
app.UseExceptionHandler("/Home/Error");
app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}/{id?}");
});
}
- 如果需要更新Swagger文档的版本，只需更改
AddSwaggerGen方法中的SwaggerDoc参数。例如，要将版本更改为v2，请将其更改为：
c.SwaggerDoc("v2", new OpenApiInfo { Title = "My API", Version = "v2" });
-
如果需要向Swagger文档添加新的API端点，请在
Startup.cs文件中添加相应的控制器和操作方法。然后重新编译并运行项目。新的端点将自动添加到Swagger文档中。 -
如果需要对Swagger文档进行其他自定义，可以使用
Swashbuckle.AspNetCore包提供的其他选项。有关详细信息，请参阅官方文档。
完成上述步骤后，ASP.NET Swagger应已更新。在浏览器中访问/swagger/v1/swagger.json（或您选择的版本），您应该能看到最新的API文档。