.NetCore 3.1 配置Swagger生成接口文檔並添加日誌（Log4net）註冊

　　　　　　最近在瞭解.NetCore 3.1,在使用Core WebApi 時，API接口信息內容不方便查看，因而配置OpenAPI Doc 進行直觀查看。

　　　　　　工具：Vs2019+Core 3.1

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

　　　　1、建立測試WebAPI 應用程序

　　　　　

　　　　　

　　　　　

 

　　　　2、添加Swagger.Core 引用 及 使用註冊

　　　　（一）、添加引用方式

　　　　　　一、使用 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 時，若是當前解決方案有多個應用程序，須要選擇默認項目爲目標。

　　　　　　　

 

 　　　　　　

 

 　　　　　　二、使用Nuget 包添加 ：（搜索：Swashbuckle.AspNetCore   --此處使用最新版本便可）

　　　　　　　　

 

 　　　　　　　　

 

 　　　　（二）、Swagger 使用註冊

　　　　　　　　一、在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
        }　　　　　　　　

　　　　　　　　　

 

 　　　　　　　　　　二、在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

　　　　3、Log4Net.Core 引用及使用註冊

　　　　　　一、此處引用方式與Swagger 引用相似，此處只作nuget 記錄  【安裝搜索關鍵字：log4net.asp 】

　　　　　　　　

 

 　　　　　　二、註冊使用

　　　　　　　　在Setup.cs -->public void Configure()-->方法添加參數：ILoggerFactory loggerFactory---》添加log4Net 註冊使用：loggerFactory.AddLog4Net();  //add log4net

　　　　　　　　

 

 　　　　　　三、在應用程序中 添加Log4net.config 配置文件 （能夠直接在log4官網上下載；Xml格式配置文件）----》設置文件屬性爲 始終複製 【.config 通常默認始終複製】

　　　　　　　　

 

 　　　　　　四、使用簡單示例：若是使用注入形式，直接使用 _logger.LogInformation()....便可。

 　　　　　　　　

 

 　　　　　4、查看API doc

　　　　　　須要在發佈或者調試過程 瀏覽 ：http://IP:Port/swagger/index.html   ----》須要指向 /swagger/index.html  。

 

 

 

　　　　以上爲本次配置記錄，若有問題，歡迎指正。

               swagger  基本講解可參考：http://www.javashuo.com/article/p-xlcnpzoq-gy.html

　　　　log4net.config 文件內容配置可參考：http://www.javashuo.com/article/p-dxkzgmak-mk.html

　　　　若是您以爲本文對您有幫助，歡迎點擊「收藏」按鈕！（/:微笑）歡迎轉載,轉載請註明出處。