Swagger UI簡介
點擊上方藍(lán)色字體，選擇“標(biāo)星公眾號”
優(yōu)質(zhì)文章，第一時間送達(dá)
SwaggerUI 特點
Swagger登場
官網(wǎng)
在項目只能使用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() 掃描類上的注解 參數(shù)是一個注解的反射對象
* 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();//構(gòu)建者模式
}
/**
* 配置Swagger信息 apiinfo
* @return
*/
private ApiInfo apiInfo(){
//配置作者信息
Contact DEFAULT_CONTACT = new Contact("James", "https://blog.csdn.net/zhanshixiang/", "[email protected]");
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() 掃描類上的注解 參數(shù)是一個注解的反射對象
* withMethodAnnotation() 掃描包上的注解
* .paths
* PathSelectors 路徑掃描接口
* ant 配置以xxx 開頭的路徑
* @return
*/
@Bean
public Docket docket(Environment environment){
//設(shè)置要顯示的Swagger 環(huán)境
Profiles profiles =Profiles.of("dev","test");
/**
* 通過 environment.acceptsProfiles 返回的boolean值判斷是否處在自己所設(shè)定的環(huán)境中
*/
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();//構(gòu)建者模式
}
/**
* 配置Swagger信息 apiinfo
* @return
*/
private ApiInfo apiInfo(){
//配置作者信息
Contact DEFAULT_CONTACT = new Contact("James", "https://blog.csdn.net/zhanshixiang/", "[email protected]");
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());
}
# 激活開發(fā)環(huán)境
spring.profiles.active=dev
server.port=8082
server.port=8083
配置API分組
.groupName("test")
/**
* 開發(fā)A組的接口
* @return
*/
@Bean
public Docket docketA(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("A");
}
/**
* 開發(fā)B組的接口
* @return
*/
@Bean
public Docket docketB(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("B");
}
/**
* 開發(fā)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;
}
}
版權(quán)聲明：本文為博主原創(chuàng)文章，遵循 CC 4.0 BY-SA 版權(quán)協(xié)議，轉(zhuǎn)載請附上原文出處鏈接和本聲明。
本文鏈接：
https://blog.csdn.net/zhanshixiang/article/details/104605292
評論
圖片
表情