springboot配置swagger

一、基本使用，使用默认配置

1、导入pom依赖，这里需要注意，swagger与springboot的版本需要对应，springboot2.5.6与swagger2.9.2版本是匹配的，不然会报

“Failed to start bean ‘documentationPluginsBootstrapper‘； nested exception is java.lang.NullPoi”

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency><!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency>

2、自定义swagger配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {}

3、写个Controller

@RestController
public class TestController {@RequestMapping("/test")public String test(){return "success";}
}

4、进入页面：ip地址：端口号/swagger-ui.html

二、自定义配置

1、上面写的配置类内容什么都没有写，启动的都是默认的配置，下面自定义配置


@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket docket(Environment environment){//指定在dev/test环境下使用swaggerProfiles profiles = Profiles.of("dev","test");System.out.println(profiles);boolean flag = environment.acceptsProfiles(profiles);return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(flag)//关闭swagger,默认是true.select()//RequestHandlerSelectors：配置要扫描的方式，有basePackage("路径")、any():扫描全部，none():全部不扫描//RequestHandlerSelectors.withMethodAnnotation():扫描方法上的注解//.withClassAnnotation()：扫描类上的注解.apis(RequestHandlerSelectors .basePackage("com.example.demo.controller"))//指定扫描的包.paths(PathSelectors.ant("/hello/**"))//设置请求路径，这里是带有hello的请求路径.build();}private ApiInfo apiInfo(){Contact contact = new Contact("单俞浩", "https://blog.csdn.net/weixin_44975592", "724629505@qq.com");return new ApiInfo("单俞浩的Api","Api Documentation","v1.0","https://blog.csdn.net/weixin_44975592",contact,"Apache 2.0","http://www.apache.org/licenses/LICENSE-2.0",new ArrayList());}
}

2、配置环境

application.properties

spring.profiles.active=pro

环境指定为pro,所以swagger不会执行

三、分组和注解

1、分组还是同样在配置类上进行，这样子就可以配置不同需求了

2、注解：常用注解有@ApiModel（“ ”）、@Api（“ ”）、@ApiOperation(" ")，主要也就是起到注释作用，在swagger也会显示相对应的注释

@ApiModel("用户类")
@Data
@RedisHash("persons")
public class Person {@Idprivate String id;@Indexed        //二级索引private String firstname;@Indexedprivate String lastname;private Address address;
}

@ApiOperation("测试接口")
@RestController
public class TestController {@RequestMapping("/test")public String test(){return "success";}@ApiOperation("测试用户接口")@PostMapping("/hello")public Person hello(Person person){return person;}
}

效果图

springboot配置swagger相关推荐

SpringBoot配置swagger-ui可视化接口文档
SpringBoot配置swagger-ui [提前声明] 文章由作者:张耀峰结合自己生产中的使用经验整理,最终形成简单易懂的文章写作不易,转载请注明,谢谢! 代码案例地址: ?https://g ...
六、springboot整合swagger
六.springboot整合swagger 简介 swagger 提供最强大,最易用的工具,以充分利用OpenAPI规范. 官网 : https://swagger.io/ 准备工作 pom.xml ...
Springboot整合swagger指南
Springboot整合swagger指南 1. 安装使用 1.1 下载依赖 <dependency><groupId>io.springfox</groupId> ...
SpringBoot 配置多数据源
项目Git地址:SpringBoot 配置多数据源:Jacob-multi-data-source 准备工作准备两个数据库(此模块中两个数据库一个为本地一个为远程,本地为主,远程为从).然后建表. ...
[Swagger2]SpringBoot集成Swagger
SpringBoot集成Swagger 引入依赖 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 ...
解决高版本SpringBoot整合swagger时启动报错：Failed to start bean ‘documentationPluginsBootstrapper‘ 问题
一.控制台的报错信息 2021-12-29 15:15:04 [main] ERROR org.springframework.boot.SpringApplication - Application ...
Swagger自动接口文档生成框架————springboot整合swagger总结
swagger简介: swagger是一款开源的api接口文档生成工具. Swagger的项目主页:https://swagger.io/ 目前比较流行的做法是在代码中加入swagger相关的注 ...
SpringBoot配置swagger2(亲测有效，如果没有配置成功，欢迎在下方留言)
一.导包: <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagg ...
20190909 SpringBoot集成Swagger
SpringBoot集成Swagger 1. 引入依赖 // SpringBoot compile('org.springframework.boot:spring-boot-starter-web' ...

springboot配置swagger

一、基本使用，使用默认配置

二、自定义配置

三、分组和注解

springboot配置swagger相关推荐

最新文章

热门文章