ASP .NET CORE WEBAPI 显示Swagger注释

ASP .NET CORE 显示Swagger注释

现在新建ASP .NET CORE WEBAPI都是默认引入Swagger的,但是Controll和Action的注释并没有开启,下面介绍如何三部显示代码注释

  1. 设置文档文件
    在项目属性页=>生成=>输出=>文档文件 勾选

  2. 设置 SwaggerGenOptions
    在 AddSwaggerGen时设置 文件文件


      builder.Services.AddSwaggerGen(c =>
      {
          c.SwaggerDoc("v1", new OpenApiInfo { Title = "请输入标题", Version = "v1" });

          var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.XML";
          var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
          //... and tell Swagger to use those XML comments.
          c.IncludeXmlComments(xmlPath);

      });

  1. 写注释
posted @ 2022-05-06 19:02  喜爱糖葫芦  阅读(192)  评论(0编辑  收藏  举报