17.后台系统-讲师接口（删除）和整合swagger原创

刚才呢，咱们完成了查询所有讲师列表的接口。通过这个接口把咱的环境做了一个测试，这边咱这个环境是正确的，然后下面呢，我们继续再来写个接口，下面写什么呢？咱来写一个是逻辑删除讲师接口，那这接口我们来看一下怎么做。首先呢，我们先看一下啊，里边这个实体类。用CTRL点开看一下啊。这里边呢，有这么一个地方，各位看这个特点啊，我是这么写的，Teacher记一个叫base en。在这里边放了一些公共的，首先ID我用的是自动增长，然后另外我们看这个意思，Delete的加了一个叫table log，这个是不是逻辑上标志，另外在里边呢，还有一个细节给大家说明一下啊，大家看啊。你看这是什么？Table name，它也是苞米豆MP中的一个注解，它就表示啊是一类对应呢，以那个表的名字，然后这里边有一个叫table field，表示属性对应表中的字段，但是你按照M规范，其实这个可以不写，我这都加上了，这是对应的是表，这对应的十几类，另外我这里继承了base entity it deleteity，加上一个table logic，所以它能做到逻辑删除。

然后下面呢，我们在这个CTRL里边来编写这个接口，我在里边写一下第二个。逻辑删除讲师，那咱看到啊，删除咱们用的提交方式是什么。是不是delete delete提交啊，所以加上一个delete mapping在里边起个名字，我就叫，因为删除呢，但是根据ID，就按照这种占位符的方式，我加上一个ID，这是四文中我们讲到的，然后在下面加上这个方法，我们写个public，就反映这么一个布尔类型了。

然后我叫。在方法中呢，咱们把这个占位符传到ID取到，就占位符呢，就是通过路径传递，那把它取到，加上一个注解，这个叫pass valuable，加上ID，我们来一个浪类型的ID，这样的话就得到了，得到之后调用service中的方法，咱们找这个方法。应该不是delete啊，是这个木白帝传入I地。返回的就是一个布尔类型，比如说我叫is success。现在就可以了，最后把这值我们做一个退。所以各位看啊，这就是咱们快速写的一个逻辑删除讲式接口，在里边通过站位符的方式传ad啊，专位符列解为就是路径中也会传入一个ID值，也就说这个意思，比如说我们这个名字叫。

然后后面ID，比如ID是一，那我这种方式进行传递，所以现在接口咱就完成了开发。完成开发之后呢，下面呢，我们肯定是进行测试，但是测试呢出现了一个问题，大家注意啊。刚才我这个是不是get提交，Get提交你浏览器能直接访问，但是我这个底delete的提交，浏览器没法直接访问，法浏览器只能直接测试get体交，而你是比delete的体交没法这些测试，那咱们该怎么做呢？给各位说明啊，这里边有很多种方式，首先第一种方式咱们可以找一些测试工具进测试，比如说有一个工具叫POS麦，你装一个K测试，但这工具呢，还需要装个转件，所以我们现在通过另一种方式进行测试，什么方式我们项目中整合一个工具这个东西。叫swa two进行测试，咱用它进行测试。swa to是什么呢？它能够测试各种提交方式，另外能生成一个在线的接口文档。

所以咱们项目中是整合swag进行测试，比如说后面咱都这么做，把接口写完之后，通过swag测试，测试没有问题，咱们开发前端最终把功能做到，所以下面咱就开始整合这个swa稿，具体说是swa哥to完成接口测试。这个好处就是什么呢？不需要装软件，在你的项目中直接整合，直接加个配置类就可以了，下面啊，咱们快速整合一下这个SPA。咱们看怎么来做啊，我在图里边给大家画一下啊这个过程。就是因为咱们的删除是。比例的提交，而这个提交呢，浏览器它没法直接测试，所以我们就通过整合这个叫swa two。进行这个接口测试，18个two能测试各种调方式的这个接口，并且能生成一个在线的一个文档，所以咱用它进行整合，那怎么整合，我说一下啊。

大家注意啊，咱们目前呢，写的是vod这个模块，后面咱是不是还会有很多模块，比如说用户的订单的很多，所以咱为了公共，那我这么来做，我在这里边呢写下啊，就是第一步。咱们在这个负工程下边创建一个子模块，比如说我叫这个common，然后在common里边来整合啊，咱这么来做，为了公共都能用到common里边，比如说可以再建一个子模块，比如叫这个。Service。我在这里边完成咱们swa的一个整合，那下面把模块我先创建出来啊，当然你写到vod中也可以，咱为了公共我就单独建一个公共模块。创建啊第一个。

建个没用工程。咱们起个名字叫common。把这个先创建出来。然后common创建之后。在里边我们引入相关一些依赖，这依赖我直接拿过来，咱们看一下这个依赖啊。大家来看啊，它比较重要的依赖，咱看核心的就这个。Swa to第一个理解为是它的核心部分，第二是它的UI页面部分，所以咱们把它引入，还有其他依赖，暂时用不到，咱先放到这里，然后创建之后把。com里面的src我先删掉。这个咱们先删除掉啊，然后删除之后在里边我们继续来看啊，下面怎么做我们进一步说明。我们在common下边呢，再来建个子模块啊，当然也可以就写在common中，咱为了规范我们再建一个，然后这个模块我起个名字叫这个。Us有一个工具模块，把这个咱做创建，然后咱们把具体代码写到这个service YouTube里面去，所以现在这个结构完成了，完成之后在wi u里边，首先我们先建个包。

那我们来做个创建这个包com点。At硅谷。硅谷课堂点上里边那个，比如咱们叫config或者叫swagger啊，那就叫swagger。这个最后创建，然后创建之后在这包里边18个怎么整合，很简单，就是建个配置类就可以了，那配置类我从课件中咱直接给他拿过来，然后在里边我们做一个创建。首先swa to config，把这个类的内容我从里边直接复制过来，咱们看一下啊，只要你依赖引入对就可以了。然后咱们看啊，首先配置类在里边加了一个叫unablewa to unable什么意思。

其实有这个开启它就表示啊，开启wa to的功能，各位记住啊，以后你见到unable都代表开启某个功能作用，然后在里边我们就写一个B，就是new个对象嘛，然后在里边你看啊这么一个结构，首先把一个叫do是swag里边的这么一个对象啊，然后第一个就是用到swa to，包括给它起个组的名字，这个名字可以随便起，下面有它的基本信息，比如你的一些相关的描述，然后看下面啊这个位置。固定结构中的这里。在这里边呢，我现在这行注掉了，注掉之后什么意思呢？就表示当前所有接口路径我们都能测试，比如说我现在把这注释打开。大家看什么意思？各位可以猜一下，你说这是什么意思？它就表示你路径中包含API这个规则的路径才显示，如果不是这个规则，那就不显示，因为咱为了自己测试，所以我就把这个所有路径都显示出来，方便咱们测试，所以现在这部分就可以了，咱们在。com里边建一个模块，SU里边加了一个配置类。

然后这个选完之后，最后咱要用一下，那怎么用呢？注意啊，Service vod里边要用，但是现在他在service u中定义了两个，不是一个模块，所以咱需要把这个service引入到这个模块中才能使用，那我来引入一下啊。我就直接放到咱的service里边去了，那我按照这个结构，咱给他改一下就可以了，因为它的结构是一样的啊，改一下啊。com.at硅谷。Service。Us。然后加上它的版本号，这给他改一下，把它引入，这样的话就可以使用，你不引入肯定不能用，然后引入之后还有最后一个步骤，这一步骤很重要，给各位说明啊。

大家注意啊。我刚才写了一个to卡。是不是一个配置类啊，而我现在项目启动是在vod中，我想实现在vod启动时候就来加载到这个配置类，因为他们不是一个工程，所以默认它是不能加载到的，那怎么加载到？我在这个就是vod的启用类里边，可以设置一下它那个包的一个扫描规则，咱们加上一个注解。大家看这个主机。叫con死看。加上你的包com.at硅谷，它就表示只要是这个包里面的相关的类都进行加载啊，因为咱把它已经引过来了。所以一启动，根据规则可以进行这个包的一个扫描，这句话必须要加上，如果你不加的话，那这配置内它是扫描不到的，不能加载这八个就不能用。以上啊，就是咱们整合的一个基本过程，咱们把这个我们就做到了，这些过程我再说一遍啊，然后最后我们来做个测试，看怎么样的。

首先我们做的过程中第一步。Common servicewi模块创建，包括引入依赖，引入之后在YouTube里边我们加上一个配置类，这配置类你直接复制可以了，把这个拿过来，然后这个写完之后，在service里边把service u刚才配置类所在的模块给它引入进来，不引入肯定不能用，然后引入之后在你项目的这个启动类上面加上一个扫描规则，因为它要扫描别的模块的配置类，你不加规则，它加载不到这个加上。然后写的时候有一点特别注意啊。就是你写包的时候，你看啊，我包的前面名字都叫com.at硅谷让它前面要保持一致，你写的时候可能你叫别的名字，但是前面都要叫相同的名字，这样的话按照这种规则进行。

扫描。所以以上啊，就是swag这么一个整合咱就完成了，完成之后把这个项目咱给他启动一下，然后最终我们进行这么一个测试啊，咱先启动啊。我在这个他先启动了，我在图上把这个补充一下啊，咱们建这个模块。然后第二步。在service。YouTube里边创建配置类第二部分，然后第三步。我们在这个service模块里边引入。Service模块。就把它引入进来。然后引入之后，最后一个别忘记啊，就是第四步。写下啊，第四步咱们在vod。启动类里边。添加上你的那个扫描的一个规则，这样的话就可以了，然后可以之后最后我们进行测试，那怎么测试，各位记住啊，Swa two。

它有一个默认的访问路径，是默认的一个路径或者一个固定的路径。然后路径是什么呢？我写一下啊，就是你当前你启动服务的IP地址。冒号你的端口号，再加上固定名字叫swagger杠。UYHTML。杠UYDHTML，用它进行访问，这是它一个固定的一个地址，那咱下面我们就访问一下啊，看一下结果。咱们看一下啊，服务应该是正常启动了，然后在浏览器中我来输入LOCAL8301加上S。杠uydtl，咱们回车。

大家看啊，这效果出来了，这就是swagger，它生成一个在线的文档，就长这样子，然后你看里边啊，找到我这个位置。这一个叫鼓励，就硅谷课堂是咱刚才写那个组的名字，比如我在培类中，你看啊这个名字，另外有一些其他的这些信息，这些信息都是我刚才。在里边写的这些值，然后最后我们测试怎么测试，找到咱们的ctrler这个teacher CR在里边，你看有两个，一个泛德欧，一个删除，咱们先找泛德欧，范德欧里边怎么应用。看到啊，这里边是一些提示信息，然后看里边一个叫try it out，咱们点上，再点这个execu一点。或者啊，然后最终你看啊，它有一个叫response状态码200，最终得到是咱这个数据。就这么一个效果啊，现在就看到了，包括这个删除一样，咱是个删除。

我在里边点这个try it out，然后这位置输入你要删除那个ID的值，咱们找一个ID，比如找这个一的这个ID，我输入一个一，然后点这个code或者X一点。看结果。各位看啊，最终返回的结果。200是不是错成功，咱们到表里边刷新看一下。刷新。各位看这值是不是就一了？就这里啊，这个值已经变成了一代表咱们已经把它逻辑删除成功了。所以以上啊，就是整合swag进行接口测试，咱们就完成了。大家发现啊，这过程特别方便，咱们只需要写个配置类，然后就可以了，然后把它引入，别忘记加上你的扫描规则。最终能生成一个在线文档，进行各种接口的测试。

这个啊，咱们就整合出来了，然后整合之后呢，最后有一个小问题，什么问题呢？大家看啊，我刚才测试应该没有问题，但是这里边因为如果说我有一个CTRL还好，如果你有很多CTRL，那咱不好找到，在里边也可以加一些中文的提示，方便咱们更好的查看，那我来加一下啊，加提示里边有三个注解。一个用在类上边，一个方法上，一个参数上，那咱们都去用下啊，给大家直接写一下，咱看一下结果就可以了。我们来写一下啊。首先在CTRL类上边，你可以加个注解。这注解名字就叫APIAPI中有一个叫tag，里面加上你的名字，比如我写一下就是。讲师。管理接口。是这上边，在方法上你也可以加注解，这注解叫做A片object，比如写第一个啊，就是查询所有教师。

然后下一个咱们叫逻辑删除讲师。可以加上注解。我改一下啊。逻辑这讲师，另外参数里边可以加主解，这个我就直接复制了啊，你加个叫APIP可以在里边加上啊，就是里边的这段话。我把这个也拿过来，所以以上啊，就是咱们完成的注解添加，让它里边有一些友好性的提示，方便咱们进行测试。那加上之后咱把服务器重启，最终再试一下啊，看一下最终结果怎么样，其实刚才测试都成功了，咱只是看一下它那个提示是否是加进去，这样的话，如果你有更多的方法，更多CTRL能够快速找到你要测试的接口到底在哪里。

咱们刷新看一下啊。大家看是不是出来了讲师管理接口点开。查询所有讲师逻辑删除，讲师逻辑删除中ID嘛，刚才我加这个大写的ID啊，咱们做那个提示。所以现在啊，Swa two就完成了整合，咱后面都是编写接口，然后通过swa two整合。进行测试，如果接口测试成功，咱再开发前端，最终实现我们的功能。