项目配置swagger---(亲测能用)
一,前言
Swagger的好处这里就不在敷衍了, 高效简洁界面优美节省时间等等读者可以自己去查,本博文主要是介绍怎么从零开始,将swagger 添加配置到一个项目中去.
之前公司团队重要有人研究了 swagger, 推向了整个公司, 大大的提升了公司,开发人员的效益,当时自己只是停留在会用,感觉非常的高效好用阶段,没有自己动手从零开始配置,几年后这次换一家公司,很多人还是用 postman这个相对效率低下的工具,索性我就自己拾起 swagger 并将其推向自己的团队.
二,问题
怎么讲 swagger 从零配置到一个项目中?
三,解决方案:
1,查了很多的教程,博客, 也尝试实践了很多,例如下面的博客,但是几乎都是非常的繁琐, 冗余呀!
https://blog.csdn.net/sinat_27639721/article/details/73104843
类似的博客大同小异,很多都是互相的抄袭,实践了好几个,很多博文都是缺少东西.
感觉自己收获甚少, 最后通过大米时代师兄弟妹们互相交流,最后研究成功,并且过程其实非常的简单:
2, 大米时代方案:
你没有看错,就只需该两个地方就成了.
(1) Springmvc的配置文件里添加
<bean class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration" id="swagger2Config"/>
<mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>
(2)web工程中的pom文件中添加
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.5.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.5.0</version>
</dependency>
随便一个出来结果如下:
如果需要注明返回方式,还需在Controller 中写明请求的方式:是 get/put/post等方式即可例如下:
四,总结
学习是如此的有趣,快乐,谢谢我的师傅,谢谢当年引导我学习成长的导师,现在的感受是越来越有意思,学习越来越有趣, 让尽可能的每天让自己有进步, 有记录有成长的足迹.
谢谢您的阅读, 愿和大家一同交流学习,共同进步和成长.