配置Swagger


方法说明

Path.Combine:方法是用来拼接路径

AppContext.BaseDirectory:方法是用来获取当前dll的目录


生成XML

我们需要将需要生成注释的类库添加到 web层的bin 里面

image.png

右键生成项目看XML有没有


方法说明

Path.Combine:方法是用来拼接路径

AppContext.BaseDirectory:方法是用来获取当前dll的目录


配置代码

打开Startup.cs 在ConfigureServices 添加

  services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "Emes", Version = "v1" });
                c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "Emes.xml"),true);//web层设置true
                c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "EmesBizCore.xml"));
                c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "DbModel.xml"));
            });

需要注意的是  Web层一定要设置true ,不然控制器名称的注释不显示


默认收缩

因为API太多不缩收起太难看,我们可以修改默认配置

     app.UseSwaggerUI(c =>
            {
                c.InjectJavascript("");
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "API");
                c.DocExpansion(DocExpansion.None);
                c.DefaultModelsExpandDepth(-1);
            });


果糖网