swagger2
-
swagger2可以将项目的所有接口在一个UI界面上展示出来,同时表明了这个接口的用途,接口需要的参数是什么类型参数是否必须,输入了参数可以直接测试接口类似postman的功能,会显示接口请求的状态码和返回的数据结构。swagger2是通过扫描很多的注解来获取数据帮我们展示在ui界面上的。
-
优点:
- 大大减少前后端的沟通
- 方便新人了解项目
- 提高团队的开发效率
-
注解使用:
@Api(tags = "货物相关") //说明类的用处 @ApiOperation("查询备品备件库存")//说明方法的用处 @ApiModel("查询备品备件库存Dto") //说明实体类的用途 @ApiModelProperty("货物名称") //说明实体类的字段意思 @ApiImplicitParams( @ApiImplicitParam(name = "stationInfoIdEquipment", value = "设备关联台站id") )