- 首先在VS打开 Nuget管理 搜索 Swashbuckle.AspNetCore 并安装到
对应的项目上
- 打开Startup.cs 找到ConfigureServices 方法
services.AddSwaggerGen(c=>{
c.SwaggerDoc("V1", new Microsoft.OpenApi.Models.OpenApiInfo {
Title="API接口标题",
Version="版本",
Description="说明"
});
});
- 在找到 Configure 方法 添加以下代码
app.UseSwagger();
app.UseSwaggerUI(C=> {
C.SwaggerEndpoint("/swagger/V1/swagger.json", "说明");
C.DocumentTitle = "标题";
});
4.到这一步基本配置完毕, 出现以下错误是因为少了 app.UseSwagger();
-
运行的时候会发现接口上没有注释,在VS中已经给对应的接口标明注释了,运行后却看不到标注的注释。首先需要配置一下,选中项目,右键–属性–生成
点击红色箭头标注的框,设置生成的XML路径
为了避免跳出不必要的提示警告,在蓝色箭头指向的框中加入1591,完毕后保存
-
回到第二步,在ConfigureServices 方法中的services.AddSwaggerGen中加入`
var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录
var xmlPath = Path.Combine(basePath, "RecordAPI.xml")//文件名要与上一步设置的XML文件名一直;
c.IncludeXmlComments(xmlPath);
参考引用
https://www.cnblogs.com/lucky_hu/p/11130209.html