在pom中引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
创建config文件
创建config文件夹,新建SwaggerConfig文件
package com.example.ctb.config;
import io.swagger.models.Contact;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**").addResourceLocations(
"classpath:/static/");
registry.addResourceHandler("swagger-ui.html").addResourceLocations(
"classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations(
"classpath:/META-INF/resources/webjars/");
WebMvcConfigurer.super.addResourceHandlers(registry);
}
/*
这个方法的返回值交给Spring 管理
*/
@Bean
public Docket petApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//哪些包需要生成文档
//com下所有的API都交给swagger2
.apis(RequestHandlerSelectors.basePackage("你想交给Swagger处理的API文件")) //指定提供接口所在的基包
.build();
}
/**
* 该套 API 说明,包含作者、简介、版本、host、服务URL
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("你的标题")
// .contact(new Contact("hmtest", "", "hm@域名反写"))
.version("版本")
.description("API")
.build();
}
}
重启springboot,进入可视化界面
浏览器输入http://127.0.0.1:8088/swagger-ui.html进入可视化界面
8088是我设置的后端端口,8080一般被前端占用了
ps:可能会出现报错
Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
可能是版本对应问题https://blog.csdn.net/hadues/article/details/123753888
我用的版本如下
springboot:2.5.6
swagger2:2.9.2