在springboot中如何应用swagger测试接口

nxhcyvvy

已于 2024-02-04 10:56:42 修改

阅读量428

点赞数 8

分类专栏： springBoot 文章标签： java

于 2024-01-28 15:13:18 首次发布

本文链接：https://blog.csdn.net/nxhcyvvy/article/details/135895779

版权

springBoot 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

本文介绍了如何在SpringBoot项目中集成Swagger进行API文档生成，包括添加依赖、编写配置类，以及处理IDEA中的错误和访问SwaggerUI。还提及了配置pathmatch和处理Swagger路径拦截的问题。

摘要由CSDN通过智能技术生成

1、导入依赖

        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>spring-boot-starter-swagger</artifactId>
            <version>1.5.1.RELEASE</version>
        </dependency>

        <dependency><!--添加Swagger依赖 -->
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency><!--添加Swagger-UI依赖 -->
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2、编写配置类

package com.wms.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 SwaggerConfig {

    @Bean
    public Docket customDocket(){
        return new Docket(DocumentationType.SWAGGER_2)
             .apiInfo(apiInfo())
             .select()
             .apis(RequestHandlerSelectors.basePackage("com.wms.controller"))
             .paths(PathSelectors.any())
             .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口测试")
                .version("1.0.0")
                .build();
    }
}

3、

idea报错

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException

在yml中添加下面的配置
spring:
mvc:
pathmatch:
matching-strategy: ant_path_matcher
加上这一段配置

4、访问（开启swagger功能）
http://localhost:8090/swagger-ui.html

5、注意自己配置的拦截器放行swagger路径(没有拦截器请忽略)

这里是放行静态资源

package com.itheima.config;

import com.itheima.interceptors.LoginInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private LoginInterceptor loginInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //登录接口和注册接口不拦截
        registry.addInterceptor(loginInterceptor).excludePathPatterns("/user/login","/user/register"
                ,"/swagger-ui.html",
                "/webjars/springfox-swagger-ui","/webjars/springfox-swagger-ui/**"
        ,"/**/swagger-ui/**", "/**/swagger-resources/**");
    }


}