Springboot 引入Swagger2

最新推荐文章于 2023-07-06 20:00:00 发布

weixin_55507632

最新推荐文章于 2023-07-06 20:00:00 发布

阅读量196

点赞数

分类专栏： java 文章标签： spring boot java

本文链接：https://blog.csdn.net/weixin_55507632/article/details/127296767

版权

java 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

前后端分离模式下，引用Swagger2有效可以解决手写Api文档

一、pom.xml引入依赖

<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>

二、Swagger配置类

package com.*.*.configuration;

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;

/**
 * @author debao
 * 
 */

@Configuration
@EnableSwagger2
public class Swagger2{
        /**
         * 通过 createRestApi函数来构建一个DocketBean
         * 函数名,可以随意命名,喜欢什么命名就什么命名
         */

        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)

                    .apiInfo(apiInfo())//调用apiInfo方法,创建一个ApiInfo实例,里面是展示在文档页面信息内容
                    .select()
                    //控制暴露出去的路径下的实例
                    //如果某个接口不想暴露,可以使用以下注解
                    //@ApiIgnore 这样,该接口就不会暴露在 swagger2 的页面下
                    .apis(RequestHandlerSelectors.basePackage("com.*.*.controller")) //扫描控制类的路径
                    .paths(PathSelectors.any())
                    .build();

        }

        //构建 api文档的详细信息函数
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    //页面标题
                    .title("user服务端提供者接口平台")
                    //条款地址
                    .termsOfServiceUrl("http://despairyoke.github.io/")
                    .contact("技术开发部")
                    .version("1.0")
                    //描述
                    .description("API 服务相关数据接口")
                    .build();
        }
}

启动类加上注解@EnableSwagger2 表示开启Swagger

package com.*.*;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class CustomerApplication {
    public static void main(String[] args) {
        SpringApplication.run(CustomerApplication.class, args);

    }
}

控制类Controller增加Swagger2的注解来说明接口的信息

@ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Integer", paramType = "path")

其实不需要加上API注解也可以正常使用，启动SpringBoot项目，访问 http://localhost:8080/swagger-ui.html

访问路径时找不到，报404，可能是配置冲突，排除是否访问静态资源路径配置冲突

解决：

通过WebMvcConfigurer，实现addResourceHandlers方法，设置静态资源可访问

package com.*.*.configuration;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 初始配置
 *
 */
@Configuration
public class WebMvcConfiguration implements WebMvcConfigurer {

    //访问静态资源
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 解决swagger无法访问
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");

    }
}