Swagger UI简介
点击上方蓝色字体，选择“标星公众号”
优质文章，第一时间送达
SwaggerUI 特点
Swagger登场
官网
在项目只能使用SwaggerUI
springboot集成Swagger
</dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
在这里插入代码片
@Configuration
@EnableSwagger2 //开启swagger2
public class SwaggerConfig {
}
Swagger配置扫描接口
/**
* 配置了Swagger 的Docket的bean实例,扫描接口的位置
* .apis
* RequestHandlerSelectors 配置swagger扫描接口的方式
* basePackage() 指定要扫描哪些包
* any() 全部都扫描
* none() 全部不扫描
* withClassAnnotation() 扫描类上的注解 参数是一个注解的反射对象
* withMethodAnnotation() 扫描包上的注解
* .paths
* PathSelectors 路径扫描接口
* ant 配置以xxx 开头的路径
* @return
*/
@Bean
public Docket docket( ){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.groupName("James")
.select()
.apis(RequestHandlerSelectors.basePackage("com.study.swagger.controller"))
//.paths(PathSelectors.ant("/hello/**"))
.build();//构建者模式
}
/**
* 配置Swagger信息 apiinfo
* @return
*/
private ApiInfo apiInfo(){
//配置作者信息
Contact DEFAULT_CONTACT = new Contact("James", "https://blog.csdn.net/zhanshixiang/", "zhanshixiang1997@163.com");
return new ApiInfo(
"James 的Swagger API文档",
"码出高效",
"v1.0",
"https://blog.csdn.net/zhanshixiang/",
DEFAULT_CONTACT,
"Apache 2.0",
"http://www.apache.org/licenses/LICENSE-2.0",
new ArrayList());
}
配置是否自动启动Swagger
/**
* 配置了Swagger 的Docket的bean实例,扫描接口的位置
* .apis
* RequestHandlerSelectors 配置swagger扫描接口的方式
* basePackage() 指定要扫描哪些包
* any() 全部都扫描
* none() 全部不扫描
* withClassAnnotation() 扫描类上的注解 参数是一个注解的反射对象
* withMethodAnnotation() 扫描包上的注解
* .paths
* PathSelectors 路径扫描接口
* ant 配置以xxx 开头的路径
* @return
*/
@Bean
public Docket docket(Environment environment){
//设置要显示的Swagger 环境
Profiles profiles =Profiles.of("dev","test");
/**
* 通过 environment.acceptsProfiles 返回的boolean值判断是否处在自己所设定的环境中
*/
boolean flag = environment.acceptsProfiles(profiles);
System.out.println(flag);
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.groupName("James")
//.enable(flag) //enable配置是否自动启动swagger 如果为False则为不启动，浏览器中不能访问Swagger
.select()
.apis(RequestHandlerSelectors.basePackage("com.study.swagger.controller"))
//.paths(PathSelectors.ant("/hello/**"))
.build();//构建者模式
}
/**
* 配置Swagger信息 apiinfo
* @return
*/
private ApiInfo apiInfo(){
//配置作者信息
Contact DEFAULT_CONTACT = new Contact("James", "https://blog.csdn.net/zhanshixiang/", "zhanshixiang1997@163.com");
return new ApiInfo(
"James 的Swagger API文档",
"码出高效",
"v1.0",
"https://blog.csdn.net/zhanshixiang/",
DEFAULT_CONTACT,
"Apache 2.0",
"http://www.apache.org/licenses/LICENSE-2.0",
new ArrayList());
}
# 激活开发环境
spring.profiles.active=dev
server.port=8082
server.port=8083
配置API分组
.groupName("test")
/**
* 开发A组的接口
* @return
*/
@Bean
public Docket docketA(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("A");
}
/**
* 开发B组的接口
* @return
*/
@Bean
public Docket docketB(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("B");
}
/**
* 开发C组的接口
* @return
*/
@Bean
public Docket docketC(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("C");
}
配置实体类信息
@ApiModel("用户实体类")
public class User implements Serializable {
@ApiModelProperty("用户名")
private String username;
@ApiModelProperty("密码")
private String password;
配置接口方法
@Api("Hello控制类")
@RestController
@RequestMapping("hello")
public class HelloController {
@GetMapping(value = "say")
public String hello() {
return "hello ";
}
/**
* 只要接口中,返回值中存在实体类，他就会被扫描到Swagger中
* @return
*/
@PostMapping(value = "/user")
public User user(){
return new User();
}
/**
* ApiOperation接口，不是放在类上的，是方法
* @return
*/
@ApiOperation("hello控制类")
@GetMapping(value = "/hello2")
public String hello2(@ApiParam("用户名") String username){
return "hello"+username;
}
@ApiOperation("Post测试类")
@PostMapping(value = "/post")
public User post(@ApiParam("用户") User user){
return user;
}
}
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：
https://blog.csdn.net/zhanshixiang/article/details/104605292
评论