飙血推荐
  • HTML教程
  • MySQL教程
  • JavaScript基础教程
  • php入门教程
  • JavaScript正则表达式运用
  • Excel函数教程
  • UEditor使用文档
  • AngularJS教程
  • ThinkPHP5.0教程

Springboot整合swagger-

时间:2022-05-29  作者:aiqingbi-aifeifei  

1:pom引入swagger的包

     <dependency>
            <groupId>域名ngfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>域名ngfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>

2:添加swagger配置

package 域名域名ig;


import 域名域名域名e;
import 域名域名;
import 域名域名iguration;
import 域名域名nfoBuilder;
import 域名域名Selectors;
import 域名域名estHandlerSelectors;
import 域名域名nfo;
import 域名域名act;
import 域名.DocumentationType;
import 域名域名域名et;
import 域名域名leSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 读取配置文件中的开关
     */
    @Value("${域名le:false}")
    private boolean enable;


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger测试")
                .description("")
                .contact(new Contact("swagger测试", "域名", "1111111@域名"))
                .version("1.0.1")
                .build();
    }
    
    @Bean
    public Docket createRestApi() {
        return new Docket(域名GER_2)
                .enable(enable)
                .apiInfo(apiInfo())
                .select()
                //swagger扫描的包路径,注意:如果写的swagger API注解不在如下包内,则swagger页面不会显示  后面会添加controller进行演示
                .apis(域名Package("域名域名roller"))
                .paths(域名())
                .build();
    }


}

3:在配置文件中,把swagger开关打开,

域名le=true

如果不打开,swagger访问页面将会报错,如图

4:在controller中添加注解:包路径:域名域名roller;

package 域名域名roller;


import 域名域名;
import 域名域名mplicitParam;
import 域名域名mplicitParams;
import 域名域名peration;
import 域名域名roller;
import 域名.域名apping;
import 域名.域名estMapping;
import 域名.域名estParam;
import 域名.域名onseBody;

@Controller
@Api(tags = "swagger测试模块")//标题
@RequestMapping("/swagger")
public class SwaggerTextController {



    @ApiOperation("getSwaggerStr测试") //方法标题
    @ApiImplicitParams({
            @ApiImplicitParam(value = "值", name = "key", dataTypeClass = 域名s, required = true) //方法参数注释
    })
    @GetMapping("/get")
    @ResponseBody
    public Object getSwaggerStr(@RequestParam String key){
        return "传入的值是:" + key;
    }
}

5:再添加一个包,不在swagger指定的域名域名roller这个包下,包路径:域名域名;

package 域名域名;


import 域名域名;
import 域名域名mplicitParam;
import 域名域名mplicitParams;
import 域名域名peration;
import 域名域名roller;
import 域名.域名apping;
import 域名.域名estMapping;
import 域名.域名estParam;
import 域名.域名onseBody;

@Controller
@RequestMapping("noswagger")
@Api(tags = "swagger不会显示的接口信息")
public class NoSwaggerController {



    @ApiOperation("不显示swagger接口信息")
    @ApiImplicitParams({
            @ApiImplicitParam(value = "值", name = "key", dataTypeClass = 域名s, required = true)
    })
    @GetMapping("/get")
    @ResponseBody
    public Object getSwaggerStr(@RequestParam String key){
        return "传入的值是:" + key;
    }

}

6:打开swagger地址:http://localhost:8016/swagger-域名#/

 7:如果整合过程中有如下报错

Failed to start bean \'documentationPluginsBootstrapper\'; nested.....

解决思路是,改变springboot和swagger的版本,他们存在一些依赖关系

对应关系大概如下:

springboot:2.6.x  对应swagger 2..9.2版本

springbot:2.6.5 对应swagger:3.0.0

8:最后点击测试:成功响应

湘ICP备14001474号-3  投诉建议:234161800@qq.com   部分内容来源于网络,如有侵权,请联系删除。