Springboot项目引入Swagger

最新推荐文章于 2025-03-18 11:10:48 发布

置顶程序浪

最新推荐文章于 2025-03-18 11:10:48 发布

阅读量814

点赞数 1

分类专栏： Java 后台开发

本文链接：https://blog.youkuaiyun.com/u010368726/article/details/104988381

版权

Java 同时被 2 个专栏收录

14 篇文章

订阅专栏

后台开发

2 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中集成Swagger2，包括创建项目、导入依赖、配置Swagger、添加资源映射及处理JWT认证，最后通过浏览器访问Swagger界面完成验证。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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，搞定