SpringBoot集成Swagger2【简单】

谁借莪１个温暖的怀抱￠ 2022-12-06 05:21 270阅读 0赞

### **前言：** ###

### **       关于swagger的使用就不介绍了，使用swagger主要是便于前后端对接，快速开发。** ###

\------------------------------------------------------------------间隔符，突然字很小，不习惯--------------------------------------------------------------------

**总：纵观springboot集成任何技术，无非以下三点，就是方便方便方便！**

1、导包
    2、编写配置
    3、开启注解

**1、导入swagger所需依赖**

<dependency>
                    <groupId>io.springfox</groupId>
                    <artifactId>springfox-swagger2</artifactId>
                    <version>2.7.0</version>
                </dependency>
                <dependency>
                    <groupId>io.springfox</groupId>
                    <artifactId>springfox-swagger-ui</artifactId>
                    <version>2.7.0</version>
                </dependency>

**2、编写swagger配置文件**

@Configuration
    @EnableSwagger2
    public class SwaggerConfig {
    
        @Bean
        public Docket createRestApi() {
            List<Parameter> params = new ArrayList<>();
            params.add(new ParameterBuilder().name("token")     //这里默认每个接口添加token令牌
                    .description("请求令牌")
                    .modelRef(new ModelRef("string"))
                    .parameterType("header")
                    .required(false).build());
    
            //设置全局响应状态码
            List<ResponseMessage> responseMessageList = new ArrayList<>();
            responseMessageList.add(new ResponseMessageBuilder().code(404).message("找不到资源").responseModel(new ModelRef("ApiError")).build());
            responseMessageList.add(new ResponseMessageBuilder().code(400).message("参数错误").responseModel(new ModelRef("ApiError")).build());
            responseMessageList.add(new ResponseMessageBuilder().code(401).message("没有认证").responseModel(new ModelRef("ApiError")).build());
            responseMessageList.add(new ResponseMessageBuilder().code(500).message("服务器内部错误").responseModel(new ModelRef("ApiError")).build());
            responseMessageList.add(new ResponseMessageBuilder().code(403).message("没有访问权限").responseModel(new ModelRef("ApiError")).build());
            responseMessageList.add(new ResponseMessageBuilder().code(200).message("请求成功").responseModel(new ModelRef("ApiError")).build());
    
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                    .select()
                    // 默认显示所有controller
                    .apis(RequestHandlerSelectors.basePackage("com.xxxx"))//包名
                    .paths(PathSelectors.any()).build()
                    .globalOperationParameters(params)
                    .globalResponseMessage(RequestMethod.GET, responseMessageList)
                    .globalResponseMessage(RequestMethod.POST, responseMessageList)
                    .globalResponseMessage(RequestMethod.PUT, responseMessageList)
                    .globalResponseMessage(RequestMethod.DELETE, responseMessageList);
        }
    
        /**
         * @return
         */
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
            .title("Spring Boot中使用Swagger2构建RESTful APIs")
            .description("managecloud_teacher")
    //        .termsOfServiceUrl("https://blog.csdn.net/qq_40437152")
            .version("1.0").build();
            }
    
            }

**3、添加注解    --在接口上添加注解**

@GetMapping("/queryDept/{id}")
        @VerifyToken // 添加登录验证
        @ApiOperation(value = "/queryDept/{id}",tags = "根据id 查询",notes = "")
        public Dept queryDept(@PathVariable("id") Long id) {
            System.out.println("!!!!!"+id);
            return deptService.queryDept(id);
        }

**4、访问：http://ip:port/swagger-ui.html**

\*\***这里页面因版本不同，显示也不同，不喜欢的可自行在maven仓库中找到自己喜欢的。\*\***

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNDM3MTUy_size_16_color_FFFFFF_t_70][]

**5、如果项目中配置拦截器，应过滤掉swagger资源，参照如下：**

@Override
        public void addResourceHandlers(ResourceHandlerRegistry registry) {
            //过滤swagger
            registry.addResourceHandler("swagger-ui.html")
                    .addResourceLocations("classpath:/META-INF/resources/");
    
            registry.addResourceHandler("/webjars/**")
                    .addResourceLocations("classpath:/META-INF/resources/webjars/");
        }

ending！！！

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNDM3MTUy_size_16_color_FFFFFF_t_70]: /images/20221123/0e574d0ec1bf48d6811f905ab3370463.png