Taurus .Net Core 微服务开源框架:Admin 插件【4-6】 - 配置管理-Mvc【Plugin-Doc 接口测试及文档】

发布时间 2023-12-26 16:04:03作者: 路过秋天

前言:

继上篇:Taurus .Net Core 微服务开源框架:Admin 插件【4-5】 - 配置管理-Mvc【Plugin-Admin 后台】

本篇继续介绍下一个内容:

系统配置节点:Mvc - Plugin - Doc 接口测试及文档:

配置界面如下:

 

 配置说明如下:

1、Doc.IsEnable:配置当前接口测试文档插件是否可用

这是一个需要特别注意的开关:

开发时可以打开、部署时可以关闭【避免暴露接口】

打开开关时,可以通过访问路径访问,例如:

 当然需要注意一下:新添加的控制器的类和方法有写注释,才会出来接口列表。

2、Doc.Path:配置后台管理页面的路径

默认路径是/doc,部署上线时,为了安全,可以修改该路径,避免有心人上去搞事。

3、Doc.HtmlFolderName:配置加载的 html 视图路径

当前的 html 页面数据,默认存档在 /Views/doc目录下。

如果该 doc 目录项目需要使用,则可以修改该目录名称。

4、Doc.DefaultImg:自动化测试 的默认图片路径

可以填写默认图片的相对路径,如:/xxx/xxx.jpg

该选项的使用场景说明如下:

对于该测试过的数据,该插件会缓存在浏览器中,唯图片除外。

如下图,只要测试过一遍,可以通过列表上面的 RunAll 按钮,重新执行所有测试,涉及图片上传的,则会选用该图片作为默认上传图。

 

5、Doc.DefaultParas:自定义全局的请求头参数

比如整个工程,新增两个测试请求头如:"code,mycustom"。

然后进入接口详情页,可以看到如下图:

 

总结:

无。