【Java】Swagger2介绍与整合Swagger2过程:

1.官方地址: https://swagger.io/

2.手写Api文档的几个痛点: 文档需要更新的时候,需要再次发送一份给前端,也就是文档更新交流不及时。 接口返回结果不明确 不能直接在线测试接口,通常需要使用工具,比如postman 接口文档太多,不好管理

Swagger也就是为了解决这个问题,通过一些配置可以生成文档,当然也不能说Swagger就一定是完美的,当然也有缺点,最明显的就是代码移入性比较强。

3.APi一览:

4.SpringMVC配置Swagger2: 首先你先有个Spring+SpringMVC项目,接下来继续配置:

4.1 pom.xml继续配置:

4.2 假设项目包名 com.naton 创建文件夹:com.naton.conf conf目录下创建文件:SwaggerConfig.java: 代码:

4.3为了访问swagger-ui.html,我们配置对这些静态资源的访问,创建文件:WebAppConfig.java

4.4测试地址:http://localhost:端口/项目名字/swagger-ui.html

4.5接口配置:

5.注意点:

swagger2文档建议在开发环境下使用,生产环境需要注释掉或者隐藏到登录后面。

6.springBoot配置Swagger2过程与SpringMVC配置差不多:
pom.xml配置与上面引入的maven库一样,在新建一个文件配置:

---------------------  作者:土镜问道  来源:CSDN  原文:https://blog.csdn.net/Jack_EUSong/article/details/80349694  版权声明:本文为博主原创文章,转载请附上博文链接!