如何使用Spring Boot集成Swagger

這篇文章主要講解了“如何使用Spring Boot集成Swagger”，文中的講解內容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“如何使用Spring Boot集成Swagger”吧！

1. 添加Maven坐標

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!-- 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>

2. 編寫一個配置類

@Configuration //配置類
@EnableSwagger2// 開啟Swagger2的自動配置
public class SwaggerConfig {
	@Bean
	public Docket docket() {
		// 設置要啟用Swagger的環境
		Profiles profiles = Profiles.of("dev", "test");
		// 判斷當前是否處于該環境，通過 enable() 接收此參數判斷是否要啟用Swagger
		boolean flag = environment.acceptsProfiles(profiles);
		
		return new Docket(DocumentationType.SWAGGER_2)
			.groupName("group1")// 設置分組，方便多人協作開發
			.apiInfo(apiInfo())
			.enable(flag)
			.select()// 通過.select()方法，去配置掃描接口，RequestHandlerSelectors配置如何掃描接口 
			.apis(RequestHandlerSelectors.basePackage("com.example.controller"))// basePackage 掃描指定包路徑下的接口。其他掃描方式可以點開RequestHandlerSelectors的源碼查看
			.build();
	}
	
	//配置文檔信息
	private ApiInfo apiInfo() {
		Contact contact = new Contact("聯系人名字", "http://xxx.xxx.com/聯系人訪問鏈接", "聯系人郵箱");
		return new ApiInfo(
			// 標題
			"Swagger學習", 
			// 描述
			"學習演示如何配置Swagger", 
			// 版本
			"v1.0", 
			 // 組織鏈接
			"http://terms.service.url/組織鏈接",
			// 聯系人信息
			contact, 
			// 許可
"			Apach 2.0 許可", 
			// 許可連接
			"許可鏈接", 
			// 擴展
			new ArrayList<>()
		);
	}
}

3. 配置實體類

@ApiModel("用戶實體")
public class User {

	@ApiModelProperty("用戶名")
	public String username;
	
	@ApiModelProperty("密碼")
	public String password;
	
}

4. 常用注解

• @ApiOperation("xxx接口說明")：作用在接口方法上

• @ApiModel("xxxPOJO說明")：作用在實體類上

• @ApiModelProperty(value = "xxx屬性說明", hidden = true)：作用在實體類的屬性上，hidden設置為true可以隱藏該屬性

• @ApiParam("xxx參數說明")：作用在接口方法的參數上

感謝各位的閱讀，以上就是“如何使用Spring Boot集成Swagger”的內容了，經過本文的學習后，相信大家對如何使用Spring Boot集成Swagger這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！