1. 新建netcore項目
2. 使用nuget包安裝 Swashbuckle.AspNetCore
使用RestorePackagesPath屬性配置nuget包的路徑(可選)
<PropertyGroup>
<TargetFramework>net5.0</TargetFramework>
<RestorePackagesPath>..\packages</RestorePackagesPath>
</PropertyGroup>
3. 勾選生成項目xml文件
4.在Startup中添加代碼
在ConfigureServices 中添加配置。
services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" }); var basePath = HostEnvironment.ContentRootPath; var xmlPath = Path.Combine(basePath, $"{typeof(Startup).Namespace}.xml"); c.IncludeXmlComments(xmlPath, true); });
在Configure中添加代碼
app.UseSwagger();
app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); });
5.訪問
/swagger (訪問swagger頁面。)
/swagger/v1/swagger.json (查看異常頁)