使用swagger和研发小伙伴们做好朋友

写在前面

         前天突然被领导问到有没有订单详情的接口文档，迅速找了下才发现项目重构之后两年多了，竟然没有整理一份文档出来给大家方便调用，因为这个订单详情是真的“详”，涉及13张表，10个枚举，整理起来费时费力，轻车熟路的我都用了4个小时才完成这个手累的工作，当时在想，如果使用了这个东西，分分钟解决接口文档问题，联调的过程也可以和研发的小伙伴们做好朋友。

        对，swagger就是解决这种问题的，没太大技术含量，但是费时费力，大家又不太想做的事情，就有必要请出我们的工具人登场。

---

第一步，引入jar包

jar

第二步，配置

配置

注意1号位的注解和2号位的开关

第三步，先介绍几个注解，然后再看怎么用？

@Api：描述类controller

@ApiModel：描述对象entity

@ApiModelProperty：描述对象里的字段

@ApiOperation：描述类的方法

注解使用1 注解使用2

第四步：项目启动，打开url：http://127.0.0.1:8080/swagger-ui.html#/

swagger界面图 对象文档，是不是很详细啊 还可以调试，是不是很厉害

是不是so easy！有了这玩意儿，接口做好，直接丢给使用方，文档、调试一条龙，完美，收工！