117笔记问答ASP.NET Swagger 是一个用于为 ASP.NET 项目生成 Swagger 文档的工具。它可以帮助你自动生成 API 文档，并提供了Swagger UI界面供用户测试和查看API接口。
要自定义 ASP.NET Swagger，你可以按照以下步骤操作：
- 安装Swashbuckle.AspNetCore包
在你的ASP.NET项目中，打开NuGet包管理器控制台，然后输入以下命令来安装Swashbuckle.AspNetCore包：
Install-Package Swashbuckle.AspNetCore
- 配置Swagger文档路径
在 Startup.cs 文件中，找到 ConfigureServices 方法，并在其中添加以下代码：
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
});
这段代码将配置Swagger文档的路径为 /swagger/v1/swagger.json。
- 自定义Swagger文档信息
在 Startup.cs 文件中，找到 Configure 方法，并在其中添加以下代码：
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
这段代码将自定义Swagger UI页面的标题为 “My API V1”。
- 自定义API文档注释
在你的控制器类或方法上，使用 [ApiExplorerSettings(IgnoreApi = true)] 属性来忽略某些不需要显示在Swagger文档中的API。例如：
[ApiExplorerSettings(IgnoreApi = true)]
public class MyController : ControllerBase
{
// ...
}
此外，你还可以使用 [SwaggerModelProperty(Description = "自定义描述")] 属性来自定义API文档中的属性描述。例如：
public class MyModel
{
[SwaggerModelProperty(Description = "自定义描述")]
public string MyProperty { get; set; }
}
- 自定义Swagger UI
要自定义Swagger UI，你可以创建一个Swagger UI的模板文件，并将其放在项目的某个文件夹中。然后，在 Startup.cs 文件中，找到 UseSwaggerUI 方法，并将 c.SwaggerEndpoint 的第二个参数设置为你创建的模板文件的相对路径。例如：
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
c.SwaggerEndpoint("/swagger/ui/index.html", "My API V1 UI");
});
这样，当用户访问Swagger UI页面时，他们将看到你自定义的页面布局和样式。