一、导入依赖
<!-- knife4j--><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>2.0.7</version></dependency>
二、配置类
通过一下配置,将Swagger2自动配置进SpringBoot中
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).protocols(Collections.singleton("http")).host("前台网址").apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("标题").description("aurora").contact(new Contact("作者", "", "邮箱")).termsOfServiceUrl("名称").version("1.0").build();}}
三、Controller使用
通过@Api注解和@ApiOperation注解说明模块作用及接口说明。
@Api(tags = "投诉原因模块")
@RestController
public class ComplaintsCauseController {@Autowiredprivate ComplaintsCauseService complaintsCauseService;@ApiOperation("获取投诉所有原因")@GetMapping("/users/complaintsCause")public ResultVO<List<ComplaintsCause>> getAllComplaintsCause(){return complaintsCauseService.getAllComplaintsCause();}
}
四、通过访问路径
通过访问路径http://localhost:8088/doc.html,说明一下8088是我SpringBoot的端口号,你们填你们自己的,不同版本的Swagger访问的路径是不一样的。然后最终看到进到的页面就是下面这这个了