【推荐】013前置知识接文档定制1Java项目实战盈利盈利宝收益多少

盈利宝：SpringBoot+。

接下来我们来看一下定制这个接口的内容。现在这些信息实际上是不都是属于默认的生成的，我在进行定制。定制的方面包括有什么？就是这个ctrl 的说明，还有什么？参数的说明，应答结果的说明，这些都可以定制。

我们这么做，回到我刚才泡沫那去。泡沫前面这个打开应该是不影响的，因为我们的ui处理方式不一样，地址也不一样。把它打开，现在我要定制，需要用到的是外高中停顿注解。

·第一个注解，这叫做 a p i注解。这个注解是放在类上面的，也就是放在你ctrl 了类的上面。说明你这个类能干什么？有什么作用？是提供对于ctrl 功能说明的这么一个注解。注解的使用方式这样，艾特一片，这边有一个属相，钛港，然后里边就是你的功能说明。现在我要说明my control，你在它的上面加上爱的 api括号加上这个说明。

比如说我们叫做用功能接口，用功能接口这儿加完之后就可以了，然后再来启动你的应用。启动之后，这是文档。我们来刷新一下，找到用功能接口，你看这个名字是不是就变化了，这是用新的 ui？是这样来展示的。如果你要用那个旧的那个，旧的那个是死歪个 ui，你看展示是不是这样的，这是用功能接口，后面这个是你那个类的名字，点开之后有里边的方法的一个列表，就是两种不同的ui的表示方式，这是关于你这个类的功能说明a p i这个主解。

·接着我们来定制里边的这个方法的。它的一个功能，定义首先来说swag这个方法有什么用？我们怎么做，用的是谁？叫做a p i 的 operation。这个注解是放在这个方法上的，是说明这个方法能干什么？它有什么作用？它主要有两个属性用，一个是 video，一个是 fully，这个 video是对这个接口功能的简短描述，后面这个属性是详细描述，就接口要干什么，什么作用是详细描述。

我们可以这么做。使用注解是叫做 api operation。这是说明，这个方法的作用，就是它干什么用？这是放在控制器方法的上面的控制器方法的上面。放法上面，这么加这块叫做一个 pi的 operation，这个是来自于你的这个 swigg中的注解，来自于它。然后用一个v 流属性，这个是swig 的快速使用，后面还有一个是 ac，就是说，第一个swag，把成语重启，成语之后先刷新一下，用功能接口我们看到这个是get方式，这就是功能描述了，就不是你接口的方法明了，而是接口描述。点开之后在这边，这是快速使用，接口描述是不第一个死外壳的控制器，这个文字说明了，要用原本那个接口，点开之后是这个样子的在swag 快速使用。这个是详细信息，在这就是两个ui我都给你看了，反正我觉得好像这个是不是更加符合我们的使用方式。

但是这里边我没找到什么，没找到测试那个地方，看到了吗？这是不只，这有调试应该在这，这应该能调试在这，这个就是实现完了。接着我们再来看，现在这个方法功能说明完了。

再说谁呢？放的参数，说谁？说这内容和id，原先这个文档中id包括人称，这些实际上都是o型孤名。如果说你想把这些做定义，包括这个，想做说明也是可以的，说明用的是这个，用它来表示，这应该是叫a p，在r say pyro 模板，它是表示参数说明的，注解有两个，一个是带s的，一个是不带s的，在这里不是，它是代表的是一个参数的完整说明。

带s这个是什么呢？他包含了多个的，不带s将来这是一个一，这边是一个多，就是说他将来是个集合式的，也包含了多个参数说明。我们这么做，现在想要说明swag里面有两参数，我想name和这id做一个自己的描述，让他更清晰地表达参数意义。

要用到的应该是带s，这里边它是有一个v6的一个数组，所以里边是不带s。

那怎么做数组应该是括号里边是at at，它就有很多的参数使用了，内容是参数的名称，这个名称是你定义的，你要注意。如果你现在想访问r 口，这个参数名应该叫内容和id。如果你也在写名字了，比方说你写姓名了，这时候在显示过程中就应该显示姓名了。用之后看原先这个是不是叫内容？你刷一下，刷出你看是不是变姓名了？但是这样选中你看这样这个东西还有，但是多出这么一个选下来，注意点这个。所以你想这个名字和这个名字应该是不都叫内容？或者干脆就别写这个就完了。不写这个就是那个名字吗？要写写谁？要写的是name才是合适的。应该还有是v6，v6应该是姓名，姓名写一个，写个用户姓名，用户姓名后面还有谁？有一个叫做铝块，铝块是真假值，表示参数在请示中是否必须包含，真就是必须的。

还有什么？还有默认值底下发的 v6，就是参数默认值，比方张三之类的，这是默认值。还有一个什么？还有一个叫做pass，记得看是不是。还有一个看看，叫哪个？还有一个是this type是参数类型。还一个是paramotive，表示在什么位置存这个参数？就给你都写上这个例子中。哭了换一下行，太长了data type这个参数是死字类型的，pass 嘛 type这个参数是在哪儿传在请求中传，所以这个叫做query。如果你的苍蝇是在什么请求头传，这就是嗨点。

如果用的是rise的风格传，这时候这样就是pass，在表示在路径中传是这个意思。现在就是在请用体中传，这是 carry就好了，我就写完了一个参数，看一下效果，形容之后来刷新一下。

这块是 name，这是个名，参数说明干什么的类型是 carry，so beat是类型是走串儿的，这样就说明了说明了这么一个参数，然后用最原始的也能有信息，它是这个样子的。这是不是有个id看 name，这是参数名，井号蕊块就是必须那个意思，死坠是表示的类型，cry在请中传。这边是什么？是姓名词，就是描述吗？底下 chip我说张三是默认值，这是他的描述，id也可以。id 的描述再往里写，这是一个参数的，然后六号，再来一个拍着吗？然后心电图。数不清，没写艾特好。

然后这个内幕发明是 i d，然后v 了，这是用户的主键，主键on 了，其他就不写了，不写一样能通过反的基热把它描出来的，所以不用写那么多，关注写了就可以了。因为毕竟写他应该是不是也会花费一定时间的？它是一个手工写的，刷新。看一下效果，id 这是不是也有相应的内容了？看一下这个，这块也有箱子信息了吗？这就是关于参数说明这么写就行了。

光学影像测量机

测量仪器上海

自动测量

相关内容