2020年10月31日星期六

net core 3.1 swagger文档添加 不用xml配置

使用特性来描述接口而不是

安装nuget包:Swashbuckle.AspNetCore.SwaggerUISwashbuckle.AspNetCore.Annotations,配置swagger:

 1 public void ConfigureServices(IServiceCollection services) 2   { 3    services.Configure<IConfiguration>(Configuration); 4    5  6    #region 添加Swagger 7    services.AddSwaggerGen(opt=> { 8     opt.SwaggerDoc(swaggerDocName, new OpenApiInfo() { Version="v1",Title="watch api",Description="watch"}); 9     //使用annotation来描述接口 不依赖10     opt.EnableAnnotations();11 12     // 下面两句,将swagger文档中controller名使用GroupName替换13     // 在Swagger中,一个Tag可以看作是一个API分组14     opt.DocInclusionPredicate((_, apiDescription) => string.IsNullOrWhiteSpace(apiDescription.GroupName) == false);15     opt.SwaggerGeneratorOptions.TagsSelector = (apiDescription) => new[] { apiDescription.GroupName };16 17    });18 19    

没有评论:

发表评论