SpringBoot（七）：SpringBoot整合Swagger2

提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

原文地址：https://blog.csdn.net/saytime/article/details/74937664

手写Api文档的几个痛点：

Swagger也就是为了解决这个问题，当然也不能说Swagger就一定是完美的，当然也有缺点，最明显的就是代码移入性比较强。

其他的不多说，想要了解Swagger的，可以去Swagger官网，可以直接使用Swagger editor编写接口文档，当然我们这里讲解的是SpringBoot整合Swagger2，直接生成接口文档的方式。

其实这个配置类，只要了解具体能配置哪些东西就好了，毕竟这个东西配置一次之后就不用再动了。特别要注意的是里面配置了api文件也就是controller包的路径，不然生成的文档扫描不到接口。

Application.class 加上注解@EnableSwagger2 表示开启Swagger

Json格式输出类 JsonResult.class

实体User.class

项目结构：

启动SpringBoot项目，访问 http://localhost:8080/swagger-ui.html

具体里面的内容以及接口测试，应该一看就懂了。这里就不一一截图了。

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。