day06/上午/109-尚硅谷-尚融宝-Swagger的常见注解

好，那我们来看一下哈，就是在W使用的过程当中呢，它有一些常见的注解，那么常见的注解呢，它可以写在两个类型的类当中，第一种类呢，就实体类当中，我们可以写一些Spark的注解，第二种呢，就是controller里面，我们可以写一些SPA的注解，那么大家可以看到呢，在我们的嗯，这个里面呢，它会有。一个model是吧，Model里面呢，你给它展开啊，展开之后呢，这地方。嗯，我看一下啊。这块会有一个叫什么叫integral GR的对象，对吧？啊，然后这块description是什么叫积分等级表，然后下面呢，这块就是它的所有的这个对象当中的属性的啊，然后对应这个属性呢，它都会有每一个属性是什么意思都它其实就相当于给你写了一个文档，或者是说给你自动生成了一个文档，这个文档是干嘛的呢？就是当前我这个方法当中，它不是返回了一堆数据嘛，这些数据都是什么意思呀，对不对啊，如果你不是这个数据库表的设计者的话，可能有些字段呢，你需要去猜啊，那所以呢，我们希望它生成的这种文档呢，针对于每个字段呢，都能有一个解释，那你会发现在下面这个地方啊，我们就可以看到这个文档里面针对每一个字段，每一个属性啊，然后当前的这个对象是什么意思，它都有一个具体的解释，那么这个解释是哪来的呢？大家看，就是之前我们所说的代码生成器自动生。

的。我们在这个地方打开我们的代码生成器。生成的代码。那你看这款是不是就是刚才咱们所看到的所有的内容了，所以啊，其实这个是服务于谁呀，就是服务于W文档的啊，那代码生成器在生成代码的过程当中，顺便把这些都给我们生成了，也一定程度上减轻了我们开发当中的一些工作量啊，所以呢，它展示的话呢，就是在这个地方展示啊，那另外呢，针对于类。

级别的这样的一些注解呢，我们还可以有一些更多的功能，比如说呃，针对这个创建时间和更新时间在这个地方。嗯，它是好像没有一些具体的这个时间的样例哈，像这个地方就是它的一个时间，我看一下啊，还有哪块。然后呢，我们可以在这个地方嘛，就给它设置一下创建时间和更新时间的，呃，这个时间。字符串模板，比如说在这个地方呢，我们可以再加上一个逗号。写成一个example，比如说呢，我想让这个时间的标准的这个格式呢，是啊，2021年。

1月1日，然后呢，是。08:00:00，好，然后这面呢，我们可以在这边写那个example啊，然后这块呢，是2021年1月1日08:00:00，所以这块呢，就是我们的具体的一个。时间了的一个定义了，然后接下来呢，我们在这个地方呢，给它重新启动一下。好，然后接下来呢，我们再来看一下啊，刷新一下这个音面，刷新完了之后呢，还是看这个goilla，然后你会发现它这个example value这块是不是就变成我们。

刚才定义的这样的一个值了，是不是啊，所以这个就是example value啊，再有呢，就是其他的这些值呢，你都可以给他写example value，这样的话，这个默认的啊，显示的这个值呢，就按我们定义的这样去展示啊，这个是在我们的。类级别，或者是说在实体类级别常用的一些注解，好，然后接下来呢，还有更多的注解呢，实际上我们是需要加在这个controller上面的，所以呢，我们把controller打开，在controller上面呢，我们一般情况下呢，有三个特别常见的注解，第一个注解呢，是API注解。这个API注解呢，有一个tag属性，我们可以给它添加一个标签，比如说积分等级管理好，我们来重新启动一下。

然后接下来呢，我们来看一下，我们这边能刷新一下。好，大家看这个地方呢，就变成积分等级管理了，所以呢，他就让我们的文档呢，就更友好了，是不是啊，这是这一块，然后我们把它点开，点开之后呢，这里面还有相应的方法，那方法能不能做这样的一些就是注释呢，当然也可以在这个位置我们写。API al，然后这面呢，我们可以给它直接写一个，它的默认题是Y6啊，那这个Y6可以省略，那我们就可以直接写这个积分。等级列表好，然后呢，下面这地方也是一样的，叫做。根据稍等啊，快捷键是子摁多了，摁了三下。

好积分根据。根据ID删除。数据记录是吧，那如果你想对这个描述的更详细一点的话呢，你还可以这样写。就是它默认的属性叫Y6嘛，这个Y6如果你只有一个Y6的话，像这样你就可以把这个Y6省略掉啊，但是如果你还想其他的属性的话，那你那个Y6那就不能省略了，然后这块有个逗号，可以写一些其他的内容，比如说nose，这是进一步的说明，叫做。嗯，逻辑删除数据记录对吧，嗯，好。然后接下来呢，我们来重新启动一下。

好，这边我们已经启动成功啦，然后接下来呢，我们再来看一下刷新。啊，这面就有了根据ID删除数据记录，然后这面是积分等级列表，刚才我们定义的这两个注解，然后我们再把这个delete这个点开，点开之后呢，这面就是逻辑删除数据记录，也就是说nose这块啊，允许你定义一些更为详细的说明，针对这个方法有一些进一步的说明，都可以写在这儿，然后这块是一些简洁的标题性质的说明啊，所以呢，这是这两个部分的内容了，那这是我们所说的呃，方法级别controller里面方法级别的注解，然后接下来呢，还有参数级别的注解，比如说我们可以针对下面的这个parameters做注解，那么在。我们的参数这个地方。我们可以加上一个API。

啊，然后这里面呢，也是有一些注解，那默认情况下呢，它有个value，这个value呢，就是数据ID是吧，就是说解释一下数据ID，解释一下这个参数是什么啊，这个参数是ID，然后呢，同时呢，我们也可以写其他更多的内容，那如果写的话就会就得把默认省去的VALUE6再给它加回来。然后接下来呢，Example我们还可以写一个，例如有一个默认值example，比如说100行吧，就是一个数据ID，当然这里面的example的值呢，只接接收字符串展示的形式啊。然后呢，再接下来它是不是必填的required true是吧？啊这些都是常用的，当然默认情况下这种pass类型的参数呢，它就是必填的啊，所以这个其实是你可写可不写的可选啊好，然后接下来呢，我们来看一下。

好，我们刷新一下这个页面。大家看这个参数这一块是不是它就写了这个是数据ID啊，然后呢，当你想try out的时候串一下，你看他给我们一个默认的值要100啊，所以说有的时候如果这个地方啊，你就想填一个测试的时候方便是吧，就写个默认值到那，然后那你呢，就可以在接口当中呢，就写个example就行了，然后这时候我们就可直接测了SQ直接测，测完了之后它返回false，因为数据库中没有这条记录，它没有没有没有去找到这条记录，没有没有办法删啊好，所以呢，这块是我们的swer当中的常见注解。