1、使用Idea創建好Springboot項目;
2、導入swagger所需要的jar包;
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
3、新建SwaggerConfig配置文件
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
tokenPar.name("Authorization").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
pars.add(tokenPar.build());
return new Docket(DocumentationType.SWAGGER_2)
.select()
//.apis(RequestHandlerSelectors.any())
.apis(RequestHandlerSelectors.basePackage("..."))//controller所在路徑包
.paths(PathSelectors.any())
.build()
.globalOperationParameters(pars)
.apiInfo(apiInfo());
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("title")
.description("swagger文檔註釋")
.termsOfServiceUrl("服務地址")
//.contact(new Contact("content", "其它文檔url", "郵箱"))
.version("1.0")
.build();
}
}
4、繼承WebMvcConfigurerAdapter重寫addResourceHandlers方法,爲swagger配置映射文件
/**
* swagger-ui
*/
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
5、如果項目中沒有加入JWT的話,swagger已經配置好了,否則需要加入token過濾
@Override
protected void configure(HttpSecurity httpSecurity) throws Exception {
// We don't need CSRF for this example
httpSecurity.csrf().disable()
// dont authenticate this particular request
.authorizeRequests()
.antMatchers("/swagger-ui.html").permitAll()
.antMatchers("/swagger-ui.html/**").permitAll()
.antMatchers("/swagger-resources").permitAll()
.antMatchers("/swagger-resources/**").permitAll()
.antMatchers("/webjars/**").permitAll()
.antMatchers("/resources/**").permitAll()
.antMatchers("/v2/**").permitAll()
// all other requests need to be authenticated
.anyRequest().authenticated().and()
// make sure we use stateless session; session won't be used to
// store user's state.
.exceptionHandling().authenticationEntryPoint(jwtAuthenticationEntryPoint).and().sessionManagement()
.sessionCreationPolicy(SessionCreationPolicy.STATELESS);
// Add a filter to validate the tokens with every request
httpSecurity.addFilterBefore(jwtRequestFilter, UsernamePasswordAuthenticationFilter.class);
}
6、運行項目,打開瀏覽器訪問http://localhost:8080/swagger-ui.html,搞定