WebAPI文档与自动化测试

ゝ一纸荒年。 2024-03-23 18:10 50阅读 0赞

**目录**

1、控制器，项目属性里需要勾选输出Xml文档选项：

2、下载文档的网页数据

3、运行访问网址

4、接口测试：

5、批量测试：

6、微服务文档

总结：

--------------------

**本篇介绍框架的WebAPI文档与自动化测试**

## 1、控制器，项目属性里需要勾选输出Xml文档选项： ##

![8ae85241db9df6acc698ee0788381747.png][]

然后，针对方法写好注释即可，示例：

/// <summary>
    　　/// 微服务测试
    　　/// </summary>
    
    public class MSController : Controller
        {
            /// <summary>
            /// Get or Post 测试
            /// </summary>
            /// <param name="custom" type="header">post 消息</param>
            /// <param name="msg" required="true">post 消息</param>
            /// <param name="file" type="file">文件</param> 
            /// <returns>返回Json数据</returns>
            [HttpGet]
            [HttpPost]
            [MicroService]
            public void Hello(string msg, System.Web.HttpPostedFile file)
            {
                if (file != null)
                {
                    file.SaveAs(file.FileName);
                }
                if (Request.UrlReferrer != null)
                {
                    Write("From : " + Request.UrlReferrer.ToString() + "\r\n");
                }
                Write("MicroService : " + MicroService.Config.AppRunUrl + Request.Url.LocalPath + " : " + Request.HttpMethod + " : " + msg ?? "Hello" + MicroService.Config.ServerName);
            }

类特别说明：

1、类必须为Public；
    
    2、类必须有注释说明，否则API文档上会忽略不显示。

方法特别说明：

1、type的类型有三种：text（默认）、header（请求头）、file（文件）
    
    2、必填说明：required="true"
    
    3、请求需要参数可以通过注释新增，不一定需要定义为方法参数。

## 2、下载文档的网页数据 ##

如果是用源码开发的，则默认自带，如果是自己项目新建引用Nuget的，则需要下载：[点击下载][Link 1]。

说明：

对于版本(>V3.0.3)会直接打包进Nuget中，引用即生成，不需要重新下载。

.Net Framework 目录：/Views/Doc/....
    
    .Net Core 目录：/wwwroot/Views/Doc/....

## 3、运行访问网址 ##

路径为运行路径 /doc

![f01f4722e862380763801f6ee44bc97e.png][]

特别说明：

如果样式没出来，可能是缺少对静态文件的处理，补上一条即可：

app.UseStaticFiles();

![237f6077006b35a41e6f76c427b64fc6.png][]

这里点去，找到刚才注释的那个方法：

![425207a7c2804d791b7cf775ed35f70c.png][]

点进详情页：

![600e7a3f399e16d174ddaa8af554b788.png][]

这里就可以看到详细的接口文档。

参数的默认值，可以通过注释上初始定义、也可以通过Url的参数，如：msg=xxx来初始，也可以通过代码来初始：

/// <summary>
            /// 全局【方法执行前拦截】
            /// 启用时：先全局，再执行局部（若存在）。
            /// </summary>
            public static bool BeforeInvoke(IController controller, string methodName)
            {
                if (controller.ControllerName == "doc")
                {
                    controller.SetQuery("msg", "初始msg参数值。");
                }
    
                return true;
            }

## 4、接口测试： ##

可以在上图的示例值中：输入参数值，在运行请求边上：选择请求类型，和返回数据类型，然后点运行请求：

![b569b2707384f83f9f40b33dbe479d35.png][]

这样就完成轻松的 ，框架会在浏览器端缓存最后一次输入的请求参数，以后后续的测试或批量测试。

## 5、批量测试： ##

单个接口测试完后，返回控制器列表：

![b50d58976e27b09ba771ef4ead515828.png][]

这里点击：RunAll，框架会拿最后一次测试的缓存在浏览器中的数据进行批量测试。

![cd77c7978d6f862daf8ba39fac31b274.png][]

这里可以看到批量的请求结果，第1个本来也是false。

因为上一次执行的类型写的是json，把它改成text执行了一次，回来再批量才成true。

## 6、微服务文档 ##

如果框架做为微服务的注册中心，左侧目录则会出现各微服务中心的模块和地址，点击即可跳转过去文档中心。

如果其它应用也是Taurus.MVC 开发，则很方便，如果是其它应用的，最好映射到host/doc目录。

![051e5798e95bd5501de39173acd57eb9.png][]

说明：

当前是最省事的做法，后续会考虑直接在当前应用上生成测试文档，直接即可访问，而不用跳转。

## 总结： ##

本篇介绍了文档的生成、测试、批量测试与自动化测试。

后续将开启Taurus.MVC 微服务系列教程（部署教程）。

--------------------

**以下是我收集到的比较好的学习教程资源，虽然不是什么很值钱的东西，如果你刚好需要，可以评论区，留言【777】直接拿走就好了**

![c1653dd19f35495583cef3678b57b6b0.png][]

![775632765b6744fbbecbd8fdd097d1ab.png][]

**各位想获取资料的朋友请****点赞 + 评论 + 收藏****，三连！**

**三连**之后我会在评论区挨个私信发给你们~

[8ae85241db9df6acc698ee0788381747.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/d5739003cd91473894b0f1dc2da40931.png
[Link 1]: https://files.cnblogs.com/files/cyq1162/Doc.rar?t=1659425172
[f01f4722e862380763801f6ee44bc97e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/566d18f26ed94c1a85fb04c631216ca4.png
[237f6077006b35a41e6f76c427b64fc6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/4c5328376f0a4e02978596e55706b025.png
[425207a7c2804d791b7cf775ed35f70c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/28c5d8d891284097ae23950fb245ffec.png
[600e7a3f399e16d174ddaa8af554b788.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/cdd61d0fd03745c79394c0eb8bd2118b.png
[b569b2707384f83f9f40b33dbe479d35.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/b0c2dc9d2d3c49ba808c11ecfc633890.png
[b50d58976e27b09ba771ef4ead515828.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5afb86f2bb1e41548bcb70d05f880225.png
[cd77c7978d6f862daf8ba39fac31b274.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/f19a2328d4b94912acc866e19170ac20.png
[051e5798e95bd5501de39173acd57eb9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/f1b9fe826f044117b9fb2d4bbb1d0faa.png
[c1653dd19f35495583cef3678b57b6b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/19dc0d7800fe485a99dd54b7db30fd9a.png
[775632765b6744fbbecbd8fdd097d1ab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/25e4d35b55314f08b045252f8ab794fd.png