一、為工程添加pom依賴:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
二鲤拿、代碼目錄:
image.png
三假褪、配置swagger具體代碼:
package com.we.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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 Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
.apis(RequestHandlerSelectors.basePackage("com.we.ui")).paths(PathSelectors.any())//設(shè)置掃描的包路徑
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("對(duì)外API接口").description("對(duì)外API接口") //設(shè)置描述之類的東西
.termsOfServiceUrl("http://www.reibang.com/u/7fcaa9fcd2c1").contact("we").version("1.0").build();
}
}
四、使用:
因?yàn)樵O(shè)置了要掃描的包路徑近顷,所以默認(rèn)開啟該路徑下的所有API文檔注解生音,
image.png
使用@ApiOperation為接口添加文檔注解
使用@ApiIgnore忽略該接口
啟動(dòng)服務(wù),訪問: http://localhost:8080/swagger-ui.html 可見到如下頁(yè)面:
image.png
完結(jié)窒升。