【朝夕Net社区技术专刊】Core3.1 WebApi集群实战专题-Corre3.1WebApi配置集成日志/配置Swagger...


欢迎大家阅读《朝夕Net社区技术专刊》第2期

我们致力于.NetCore的推广和落地,为更好的帮助大家学习,方便分享干货,特创此刊!很高兴你能成为首期读者,文末福利不要错过哦!本文通过3大部分进行解读:

01

PART

CoreWebApi教程本地演示环境:

Visual Studio2019 --- Vsersion:16.4.4   +  NetCore3.1.2

02

PART

配置Swagger:

详解1

相信无论是前端还是后端开发,都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力,经常来不及更新。其实无论是前端调用后端,还是后端调用后端,都期望有一个好的接口文档。但是这个接口文档对于程序员来说,就跟注释一样,经常会抱怨别人写的代码没有写注释,然而自己写起代码起来,最讨厌的,也是写注释。所以仅仅只通过强制来规范大家是不够的,随着时间推移,版本迭代,接口文档往往很容易就跟不上代码了。发现了痛点就要去找解决方案。解决方案用的人多了,就成了标准的规范,这就是Swagger的由来。

详解2

通过这套规范,你只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具,就可以做到生成各种格式的接口文档,生成多种语言的客户端和服务端的代码,以及在线接口调试页面等等。这样,如果按照新的开发模式,在开发新版本或者迭代版本的时候,只需要更新Swagger描述文件,就可以自动生成接口文档和客户端服务端代码,做到调用端代码、服务端代码以及接口文档的一致性。

下面就来带大家配置一下swagger

1. nuget 管理安装程序包:Swashbuckle.AspNetCore,或者Nuget控制台命令安装:Install-Package SwashBuckle.AspNetCore -Version 5.0.0-rc4;注意;

2. 注册服务:


引入swagger中间件

3. 访问Ip:端口/swagger/index.html

Swagger展示;swagger也可以调试接口;点击try it out按钮即可;

03

PART

集成log4日志:

在系统开发中,所谓决不允许让没有任何监控的系统上线;

log4net是.Net下一个非常优秀的开源日志记录组件。log4net记录日志的功能非常强大。它可以将日志分不同的等级,以不同的格式,输出到不同的媒介

下面就是集成log4的步骤

1. nuget引入log4net程序包;当前是2.0.8版本;

2. 引入Microsoft.Extensions.Logging.Log4Net.AspNetCore程序包;这个是个扩展包;在Core里面很多都是扩展方法实现;

3. 使用log4配置文件;可以联系助教老师获取,助教微信:ZhaoxiNet007,也可以直接在log4官网上下载;Xml格式配置文件;

Log4配置文件信息如下:配置文件加入以后,需要把文件属性设置为始终复制;

 4. 调用方法使用配置文件使用log4AddLog4Net方法如果调用无参数的,注意文件路径问题;

5. 在控制器构造函数注入即可使用;


下期预告

【朝夕Net社区技术专刊】第3期:

WebApi部署多服务器配置Nginx负载均衡

本期福利

如果看完本文让你有所收获,
别忘转发扩散,和更多人分享学习的快乐!
扫码关注公众朝夕Net社区回复”第二期“
即可获取本期配套教学视频及课件!

《朝夕Net社区技术专刊》持续更新,欢迎扫码关注