springBoot集成swagger

深藏阁楼爱情的钟 2023-10-11 15:35 252阅读 0赞

*  1.springBoot集成swagger
    
     *  1.引入依赖
     *  2.添加SwaggerConfig
     *  3.在controller层添加注解

## 1.springBoot集成swagger ##

### 1.引入依赖 ###

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

*  springfox-swagger2是用于生成接口文档的，必须要依赖
 *  springfox-swagger-ui负责提供ui查询界面

### 2.添加SwaggerConfig ###

import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    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.*;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    
    @Configuration //在springboot中加载配置文件
    @EnableSwagger2 //加载swagger
    public class SwaggerConfig {
        
    
         @Bean
        public Docket api() {
        
              //添加head参数配置start---用于设置请求头
            ParameterBuilder tokenPar = new ParameterBuilder();
            List<Parameter> pars = new ArrayList<>();
            tokenPar.name(ContenConfig.TOKEN_SIGN).description("token令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
            pars.add(tokenPar.build());
            //添加head参数配置end
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo()) // 调用apiInfo方法
                    .pathMapping("/") //配置访问路径
                    .select()
                    .paths(PathSelectors.regex("/.*")) //匹配路径下的方法
                    .build()
                    .globalOperationParameters(pars);//注意这里是将请求头加入到配置中;
    
        }
    
        private ApiInfo apiInfo() {
        
            return new ApiInfoBuilder().title("")
                    .contact(new Contact("xxx", "", "xxxxxxxxxx@qq.com"))
                    .title("xxxx接口文档")
                    .description("xxxx接口文档")
                    .version("1.0.0.0")
                    .build();
    
        }
    
    }

### 3.在controller层添加注解 ###

@Api(tags = "登录")
    @Controller
    public class LoginController {
        
        /**
         * 用于app端的登录
         *
         * @param tbUser
         * @param response
         * @param request
         * @return
         */
        @ApiOperation("app端的登录实现")
    //    @ApiImplicitParam(name = "tbUser", value = "传递数据为json对象", dataType = "com.certificate.api.Po.TbUser")
        @ResponseBody
        @RequestMapping(value = "/app/login", method = RequestMethod.POST)
        public String appLogin(@RequestBody TbUser tbUser,
                                   HttpServletResponse response, HttpServletRequest request) {
        
                   
            return "swagger测试";
        }
    }

接下来访问

http://localhost:3003/swagger-ui.html

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXlpa2VqaQ_size_16_color_FFFFFF_t_70_pic_center]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXlpa2VqaQ_size_16_color_FFFFFF_t_70_pic_center 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXlpa2VqaQ_size_16_color_FFFFFF_t_70_pic_center]: https://img-blog.csdnimg.cn/20210428094619341.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXlpa2VqaQ==,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXlpa2VqaQ_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/20210428094627651.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaXlpa2VqaQ==,size_16,color_FFFFFF,t_70#pic_center

springBoot集成swagger

发表评论取消回复

还没有评论，来说两句吧...

相关阅读