1、項目下載NuGet包
Swashbuckle.AspNetCore.Swagger: 一些模型實體定義
Swashbuckle.AspNetCore.SwaggerGen: Swagger生成器
Swashbuckle.AspNetCore.SwaggerUI:Swagger UI工具
2、配置相關信息
2.1 在配置文件Startup中配置:
ConfigureServices:
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
//設置跨域Cores
services.AddCors(option => option.AddPolicy("cors",
c => c.AllowAnyOrigin().AllowAnyHeader().AllowAnyMethod()));
//配置swagger
services.AddSwaggerGen(c => {
c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "SHI_NOTE", Version = "v1" });
var xmlfile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlpath = Path.Combine(AppContext.BaseDirectory, xmlfile);
c.IncludeXmlComments(xmlpath);
}
);
}
Configure:
app.UseSwagger();
app.UseSwaggerUI(
c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "SHI_NOTE")
);
2.2 在配置Properties中launchSettings.json進行修改初始接口顯示(把launchUrl的改爲"swagger/index.html"):
"profiles": {
"IIS Express": {
"commandName": "IISExpress",
"launchBrowser": true,
"launchUrl": "swagger/index.html",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
},
2.3 自動生成xml文件
這裏可以運行接口看一下效果,應該會顯示成這樣:
我的項目已上傳github(https://github.com/Shiqing0602/.NetCore-WEBAPI-EFCore-SqlServer.)有需要的朋友可以自行觀看。