.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

　　　　若是您以为本文对您有帮助，欢迎点击“收藏”按钮！（/:微笑）欢迎转载,转载请注明出处。