项目结构图:
创建接口步骤:
1、创建一个package,命名为config
创建SwaggerConfig类和WebMvcConfig类
代码如下:
SwaggerConfig.class
@Configuration //必须存在
@EnableSwagger2 //必须存在
//必须存在 扫描的API Controller包
@ComponentScan(basePackages = {"com.example.newdemo.controller"})
public class SwaggerConfig{
public Docket customDocket() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
Contact contact = new Contact("LWN",
"http://www.baidu.com/",
"1227503249@qq.com");
return new ApiInfoBuilder()
.title("项目API接口")
.description("项目API接口的描述")
.contact(contact)
.version("1.1.0")
.build();
}
}
WebMvcConfig.class
@Configuration
class WebMvcConfig implements WebMvcConfigurer {
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
2、在pox.xml加入如下依赖
<!--swagger-api 依赖开始-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
<!--Jackson required包-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.11.2</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.11.2</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.11.2</version>
</dependency>
<!--swagger-api 依赖结束-->
在启动类里面加注解(这一步我参考的教程里写了,但是我没加也没出bug)
3、最后一步就是运行程序,在浏览器中输入
http://localhost:8080/swagger-ui.html
呈现出如下界面
over!!!