1. 导入依赖
pom.xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version> <!--版本可能会更新-->
</dependency>
2. 编写配置
/config/WebMvcConfiguration.java
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {
@Bean
public Docket docket() {
ApiInfo apiInfo = new ApiInfoBuilder()
.title("标题") // 标题
.version("2.0")
.description("描述") // 描述
.build();
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo)
.select()
.apis(RequestHandlerSelectors.basePackage("com.sky.controller")) //被扫描为接口的包路径`(`/src/main/java/`下的包路径)
.paths(PathSelectors.any())
.build();
return docket;
}
/**
* 设置静态资源映射
* @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
3. 测试
web访问:
localhost:8080/doc.html // 8080为项目路径,根据自己项目的路径来改
页面如下: