如何入门级掌握swagger2与knife4j的详细使用技巧？

本文共计4247个文字，预计阅读时间需要17分钟。

目录

1.Swagger介绍

2.Swagger常用注解

3.Swagger入门案例

4.Knife4j介绍

5.Knife4j入门案例

总结入门级Swagger2和Knife4j的详细使用重要的使用场景介绍三遍

目录

• 1、swagger介绍
• 2、swagger常用注解
• 3、 swagger入门案例
• 4、knife4j介绍
• 5、knife4j入门案例
• 总结

入门级swagger2和knife4j的详细使用

重要的使事情说三遍
重要的使事情说三遍
重要的使事情说三遍

使用swagge或knife4j都有与springboot的版本兼容问题，该文章使用的springboot版本是2.2.2.RELEASE版本，如果高版本可能会出现启动报错

1、swagger介绍

相信无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是这个接口文档对于程序员来说，就跟注释一样，经常会抱怨别人写的代码没有写注释，然而自己写起代码起来，最讨厌的，也是写注释。所以仅仅只通过强制来规范大家是不够的，随着时间推移，版本迭代，接口文档往往很容易就跟不上代码了。

使用Swagger你只需要按照它的规范去定义接口及接口相关的信息。