swagger2使用（swagger2的作用）



       这样做的好处就是后端开发人员只需要关注后端的业务，前端开发人员只需要关注前端的事情；岗位职责变得更加清晰，同时开发效率也大大提升。

在这个时候就出现了一个问题，前后端分离后数据交互的问题，前端开发工程师在去调用后端接口获取数据的时候，是要遵循一定的规则的，比如：传递给后端的参数类型等。这个规则就是我们常说的接口文档，这个文档就定义了前后端数据交互时的规范。

       作为一名程序猿，都或多或少地被接口文档折磨过，前端工程师经常抱怨后端给的接口文档与实际情况不一致；后端工程师总觉得太多的接口文档要编写以及维护接口文档会耗费不少精力，经常来不及更新。

       理想的状态应该是，编写好的接口文档同时发给前端和后端工程师，大伙按照既定的规则各自开发就OK了。

       而实际的工作中是经常充满着变化。然而，理想终归是理想。就像每个程序猿都会吐槽别的程序猿为什么总是不写注释，而自己在写代码的时候又总是很讨厌些注释一样。

       个爱动脑、爱思考、技术特别高超的程序猿群体，但凡我们在工作遇到不爽的问题，我们一定会利用我们“聪明绝顶”的大脑来把它搞定。今天我们就来说一个可以提高我们接口文档开发效率的工具swagger2。它的出现就是为了解决困扰程序猿的复杂的、难以维护的API接口的问题。

A Powerful Interface to your API

       swagger2是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful 风格的Web 服务。它主要包含三部分：

swagger提供了一个Docket 对象，我们可以灵活的配置swagger 的各项属性

@ApiModel 设置接口相关实体的描述

通过在控制器类上增加@Api注解，给控制器增加描述和标签信息。

*@Api: 可设置对控制器的描述。

我们启动一下项目，然后在浏览器中访问http://localhost:8080/swagger-ui.html 就可以看到如下的效果啦！

接口测试

点开查找用户接口，点击Tryit out，

输入用户id，然后点击Execute

测试结果

这样几步我们就完成了，SpringBoot整合swagger2的案例，相信大家都已经能够体会到swagger2对于程序员们的的便捷，赶紧动手实战吧。

到这里我们swagger2的内容就搞定了，恭喜你有Get了一个新技能。

//课工场大数据专场直播预告//

神秘一线 大咖亲临

为你带来别开生面的大数据盛宴
课工场3年磨一剑
北美专家、行业大咖、教学牛人

三点一线为你铺就大数据坦途
一起来聊一聊，大数据的“教”与“学”

我们不惧被模仿
因为我们始终无人能超越

扫描下方二维码

马上预约课工场大数据论坛专场

我们在直播间等你来！

版权声明：

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！

转载请注明出处，原文链接：https://www.xkablog.com/rfx/56163.html