.NetCore 3.1 配置Swagger生成接口文档并添加日志(Log4net)注册

      最近在了解.NetCore 3.1,在使用Core WebApi 时,API接口信息内容不方便查看,于是配置OpenAPI Doc 进行直观查看。

      工具:Vs2019+Core 3.1

      程序及引用程序集:Core WebAPI + Swagger.Core+Log4Net.Core

    一、创建测试WebAPI 应用程序

     

     

     

    二、添加Swagger.Core 引用 及 使用注册

    (一)、添加引用方式

      1、使用 PM 程序包管理器 添加:Install-Package Swashbuckle.AspNetCore -Version 5.0.0

                   (或者【最新版本5.0.0,使用后面的在nuget里会提示更新】:Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4 )----最新版本5.0.0

        使用PM 时,如果当前解决方案有多个应用程序,需要选择默认项目为目标。

       

       

       2、使用Nuget 包添加 :(搜索:Swashbuckle.AspNetCore   --此处使用最新版本即可

        

         

     (二)、Swagger 使用注册

        1、在Setup.cs -->  ConfigureServices(IServiceCollection services)   中添加注册          

 public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();

            #region AddSwagger 注册服务
            services.AddSwaggerGen(s =>
            {
                //标记swagger 信息(内容自定义)
                //V1.0.0-->SwaggerEndpoint(url,name)-->url 使用
                s.SwaggerDoc("V1.0.0", new Microsoft.OpenApi.Models.OpenApiInfo
                {
                    Title = "First_ApiInfo",
                    Version = "1.0.0",
                });
            });
            #endregion
        }        

         

           2、在Setup.cs -->  public void Configure()   中添加使用信息            

            #region swagger
            app.UseSwagger();
            app.UseSwaggerUI(su =>
            {
                //url中[V1.0.0]与ConfigureServices 中配置的SwaggerDoc("V1.0.0",..) 保持一致
                su.SwaggerEndpoint("/swagger/V1.0.0/swagger.json", "SwaggerFirstUse_Test");
            });    
             #endregion

    三、Log4Net.Core 引用及使用注册

      1、此处引用方式与Swagger 引用类似,此处只做nuget 记录  【安装搜索关键字:log4net.asp

        

       2、注册使用

        在Setup.cs -->public void Configure()-->方法添加参数:ILoggerFactory loggerFactory---》添加log4Net 注册使用:loggerFactory.AddLog4Net();  //add log4net

        

       3、在应用程序中 添加Log4net.config 配置文件 (可以直接在log4官网上下载;Xml格式配置文件)----》设置文件属性为 始终复制 【.config 一般默认始终复制】

        

       4、使用简单示例:如果使用注入形式,直接使用 _logger.LogInformation()....即可。

         

      四、查看API doc

      需要在发布或者调试过程 浏览 :http://IP:Port/swagger/index.html   ----》需要指向 /swagger/index.html  。

    以上为本次配置记录,如有问题,欢迎指正。

               swagger  基本讲解可参考:https://www.cnblogs.com/yilezhu/p/9241261.html

    log4net.config 文件内容配置可参考:https://www.cnblogs.com/skyheaving/p/12294241.html

    如果您觉得本文对您有帮助,欢迎点击“收藏”按钮!(/:微笑)欢迎转载,转载请注明出处。

原文地址:https://www.cnblogs.com/skyheaving/p/12405719.html