一.config.xml引入swagger包
<dependency> <groupId>com.spring4all</groupId> <artifactId>swagger-spring-boot-starter</artifactId> <version>1.9.1.RELEASE</version> </dependency>
二.application.yml配置swagger
###swagger如下都是非必须的配置(实际使用时请根据实际情况配置) swagger: enabled: true title: API文档 description: XXX系统设计 #接口包扫描路径 base-package: com.system.demo.controller #需排除的接口路径 exclude-path: /error/** version: ${project.version}
三.在类和方法,以及实体中添加swagger相关注解
@SpringBootApplication @EnableSwagger2 public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication .class, args); } }
@Api(value = "测试swagger") @RestController @RequestMapping("/test") public class TestController { @ApiOperation("测试swagger请求") @GetMapping("/{name}") public MyTest test(@PathVariable String name){ MyTest myTest = MyTest.builder().myName(name).myAge(18).build(); return myTest; } }
@ApiModel("测试对象") @TableName("t_my_test") @Data@Builder@AllArgsConstructor public class MyTest { @ApiModelProperty(value = "测试姓名",name = "username",example = "jack") private String myName; @ApiModelProperty(value = "测试年龄",name = "age",example = "18") private Integer myAge; }
四.测试
localhost:8082/swagger-ui.html进入swagger界面,选择对应方法,输入参数后,点击“Execute”即可