18-尚硅谷-硅谷通用权限项目-角色管理模块-CURD接口（整合Swagger2）

各位同学大家好，刚才呢，我们快速完成了逻辑删除接口，但是最终呢遇到一个问题，因为它是底例的提交浏览器没法直接测试，测试直接报了一个四零，我错误说你的提交方式不支持，所以咱们把这个底例提交要完成测试，那怎么测试给各位说一下啊，这个测试有多种方式，首先第一种方式就是各位可以在网上或者说我们找一个测试工具进行实现，这里边给大家介绍一个，这个工具名字叫postman。咱们来看一下啊，这里咱就打开这个百度百科看一下，就看一下这段话，这里写到posman是个什么接口测试工具，然后它里边相当于个客户端，能实现TP的各种请求，这是一个工具，但这工具呢，咱们还需要再装个软件才能实现，所以这里边我们还有第二种方式，那怎么做，咱通过idea可以直接测试，那怎么做，我们看一下啊，大家找到这上面有一个叫tos工具，工具里边有一个叫HTP，然后咱们点一个，把这点开之后啊，在这个位置是不是有的这么一个请求，然后你看啊，第一个什么请求方式有很多，第二个IP端口号，第三个路径，然后如果如果你有参数在里边可以添加，那咱来试一下啊，比如说我是一个查询，所有咱们是get提交，然后写一下我们的路径，注意不要写错啊。

Local house咱们是8800，然后路径复制类上边和方法上边的路径。我把这个做复制方法，上边叫find o现在完成，然后点那个绿色执行。大家看最终结果是不出来了，就是返回一个Jason的数组格式，这是用htt client，也就是我们ID中这个工具给进行测试，然后这个之后呢，我们再试一下这个底delete的提交，咱们改一下啊，底delete路径改一下，我这个叫。

然后后面路径中咱传个参数，那咱们到表里边找一下这个ID值，传个参数，我们找一个啊。把表打开，角色表大家看很多，比如说我就删这个啊，就是ID是八的，这条记录目前是零，然后咱们筛一下啊，在里边我传个八。然后点击执行，大家看返回什么是不是true，比如说我现在啊再进行一遍是false，因为你已经删过了，所以现在啊，咱们通过这个idea中这个工具就能实现不同提交方式测试，包括你是get提交，Post提交，Delete的提交，Po提交等等都能做测试，所以这是另外一种方试，但是这种方式啊有一个缺陷，你注意啊，比如说我们现在啊，在前后端开发中，因为你想一下前端开发人员，他不可能去装个idea来做这个测试，这他做不到，因为他不懂后端代码，他只懂前端，而这个接口呢，在实际中咱一般是这么一个场景，怎么做，一般有一个接口文档，我们后端拿着文档写接口，前端拿着文档进行地址的调用，然后做数据的解析，数据的处理，一般是这个流程，而现在比如说咱后端把接口写完之后。

前端是不是要测试调用了，那这个时候他要怎么看，它不可能装个idea，所以在实际中还有一种方式，大家看我课件里边啊，我们可以整合一个就是接口的测试的一个工具，叫swaggar to，通过它来做到这个的最大好处是什么呢？它第一个不需要装软件，然后第二个只要我项目启动，你知道路径，不管你在什么地方，只要浏览器就能打开这个路径，能生成一个在线的接口文档，所以咱们下面主要就是整合swag two来完成接口测试，这swa two在实际中用的也很多，然后swa two里边呢，有一个增强工具，就让它的界面更加强大，更加美观，功能更加完整，叫这个life啊，所以咱们下面来整合swa to来完成里边的这个过程，那下面咱们开始做这个事情，Swa to怎么整合，给大家说明一下啊。

刚才做了介绍，它能生成一个在线的接口文档，不需要装软件，只要你项目启动它就能用，然后这个是一个swa two的增强工具，用它能看到更多的界面显示，能看到美观界面，能做到更强大的测试功能。那下面咱就开始整合s two，那怎么整合给大家说一下啊，首先第一步我们先引入依赖，把依赖引入这里强调，因为S拉to呢，咱后面的接口中都要用到，最后把这个整合就放到咱这个公共这个模块中，也就是common模块中，我把它放到我这个这个模块啊，找到common在这里啊，就是service YouTube里边，首先第一个我先引入依赖。

这依赖我从课件中就直接复制了，这就是第一步。第一次引入呢，它会联网下载，咱需要等一会儿，等他下载完成。依赖引入之后我们来看啊，这就是刚才咱们说那个耐J拉素一个增强工具，把依赖引入，然后引入之后这里边继续来看，我们在这里边呢，建一个swa two的这个配置类，或者说叫ne的配置类，那我在里边给各位来做一个创建，咱们在里边写一下啊，放到这个位置。

首先我先建个包，这个包跟我们之前的规则咱们保持一致，为了后面方便，那我来最后创建，然后这个包com点。At硅谷system，我们叫config，在里边把类给它创建出来啊，就是这个类。类创建之后，我们看一下课件里边这个类很简单，第一个加上configuration，第二个加个anable swag to web，按VC表示开启swa two的功能，然后在里边有一个方法，就这个里边就指定你的头信息，包括你的组，包括路径的内容，那这部分给各位就直接复制了，因为是一个固定结构，各位自己写的时候直接拿过来改成你的路径就可以了，我在里边写下。

首先加个注释，就是SPA to配置类，第一个加个注解configu，第二个加个注解unable。然后加上这个注解，我们叫这个啊小写。接下这个叫nip forjj啊，里边的这个应该具体说叫这个名字啊，我把这直接拿过来啊，Unable swa y VC啊应该这个名字，这个拿过来依赖引入，然后引入之后呢，在里边把这个代码咱给它直接就复制过来，就这段。我把这复制，然后给大家解释一下啊，这个代码是什么意思，因为是一个固定结构，我就直接拿过来，首先大家看啊，第一部分叫艾特B，它就表示呢，创建对象在四中注册，首先第一部分我在里边建了一个list集合。

然后在例子集合里边做什么呢？其实就是设置你的相关这个head，或者说headde头信息，把信息我们在里边做一个设置，里边主要就是来做这些事情啊，这是我们做的就是第一部分。呃，这依赖应该导错了啊，大家给他改一下，应该不是这个依赖，呃，这个导错了，重新导一下这个依赖啊，各位注意啊，是swag里边这个依赖，所以现在啊，这部分我们就完成，完成之后我们继续来看啊，这里边报了一个错，呃，说类型不一样啊，那还是这个导的不对啊，咱再仔细看一下啊，是swag里边的，我们看一下应该是里边的这个啊，就这个啊，这是swag里边应该导它，这就对了啊，这表示设置投信息，然后第二部分呢，大家看一下啊，首先第一个。

类型是个to，然后这个是我们对它分的一个组，下面有你接口文档中的基本信息，也就是这个方法中这信息，比如说你的名字描述等等内容。然后这个之后下面呢，有它相关的包，包括路径，这路径特别说一下啊，就是这行代码给大家强调啊，我强调如果说啊，你不写这行代码，它会有什么效果呢？也就是说我们在用swa to的时候，里边所有接口路径都会显示，但是你加上这行之后什么效果，你的接口只有是以我的命开头才显示，如果不是以它开头，那就不显示，大家看我目前的接口的路径，我们看一下啊，大家看是不是一个开头，所以它会显示，如果你不是的话，也要加上别的规则，或者说把这行去掉，所以现在这个配置类就完成了，完成之后呢，我们下面做的就是在CTRL里边可以加上一些注解啊，当然也可以不加。

你加上注解就是一个目的，咱测试中为了就是中文提示更加方便，那我下面啊，改造一下咱的controller，最后我会再总结一遍啊，首先第一个在类上边咱们加上一个swa to的注解。这注解就叫A片，然后里边有一个名字叫tags，咱加上一个中文，比如就叫做角色管理的接口，这是第一个，一会咱们能看到效果，然后第二个在你的方法上边，我们加上一个注解，它叫API operation，里边咱加一个名字，第一个就是逻辑删除的接口。然后下面我复制再加一个这个接口，就是查询所有记录，所以以上我们把这个swa two就完成了整合，这就可以了，给大家再总结一遍，然后咱们开始测试。

我们是怎么做的说明啊，第一步在common里边的service里边引入了依赖，也是这个叫是to一个增强版或者增强工具，然后引入之后在里边建了一个配置类。指定配置链，指定I开启功能，然后加上这个B，加上方法，设置你的路径等信息，然后最后CTRL里边加注解，让它有中文提示，一个是类上边，一个是方法上边。通过以上步骤，这个过程我们就完成了。完成之后呢，里边有一个小细节各位要注意一下啊，还是回到我这里，首先咱们提到了啊，W boot里边启动类的扫描规则是怎么样，各位应该知道啊，是不是当前包子包，所以大家看我这个包在建的时候跟的名是不一样，Com点硅谷c conig，所以也是当前包的子包，所以启动类就能扫描到它，另外surface u在这里边应该是已经引过了，所以能够扫描到里边这个配置类，这各位要注意啊，启动类扫描是当前包及其子包，当然可以改它的规则，如果你不改的话就这规则，所以咱为了方便让包保持一致，所以现在就整合出来了。

整合之后，下面咱做个测试，我说一下怎么测试啊，给各位说明一下，首先把服务我们先请起来。等差线启动。我这里边服务已经启动了，然后咱们打开浏览器访问一个固定的路径，这路径很好记啊，各位记住啊，就是你项目的IP端口号加一个叫doc.html就可以了，我现在把这个打开，大家看一下，注意啊，这就是swa哥兔，或者说这个life j生成的在线接口文档，它就长这个样子，这里边应该说的很明确了，而这个该怎么去用，咱们下面给大家做一个测试，看一下这个文档该怎么完成测试，大家看里边啊，有一些基本的信息，这些啊，就是一些基本的一些参数，包括主页里边有咱刚才说的信息，然后咱们看这里边你看啊。

是不是有个二表示里边两个接口，这个叫角色管理接口，注意是不是就是我刚才写的这个中文，大家看是不是就是这个，然后在里边两个逻辑删除查询所有，你看里边是不是都有，那咱试一个查询所有，怎么是很简单啊，第一个你看啊，有一个文档的描述，就是里边的各种信息，然后咱点开调试，调试里边这是你的路径，当然你可以传参数，咱目前没有，我就直接点发送。

然后大家看响应内容中，你注意看啊，状态码200耗时这么长，大小这么大，然后最终这结果是不是有了，就是返回这个Jason的数组格式，就这么来做，很简单，包括你看这文档的样式，包括测试是不是也特别方便，所以前端后端我们通过它后端用于测试，前端用它做一个接口文档进行前端开发，这个就可以了，然后之后我们再试一个这个逻辑删除接口，咱们找到啊，前面是文档的描述，找到调试，然后在里边你注意啊，看这位置，我觉得这提示特别好，是不是让咱们输入参数，那比如说我来个一，然后参数之后这位置我点发送。大家看返回是不是true，我再点发送是false，因为咱已经删过了，表里边看一下数据是不是都删掉了，所以以上就是我们整合swa two，具体说是那个增强版叫ni g，通过它来实现了不同提交方式的接口测试，包括咱后面不管你是post提交，Post提交，还是我们最早的get delete提交，用这个。

都能完成，它既用于咱们的后端中，也用于前端开发中，包括里边你看到它这个界面应该是功能特别强大，另外描述也特别完善，所以这就是整合swa two完成接口的测试。