SpringBoot集成Swagger3的實現

Posted on by

一，什麼是swagger?

1,  Swagger 是一個規范和完整的文檔框架，

    用於生成、描述、調用和可視化 RESTful 風格的 Web 服務文檔

    官方網站:https://swagger.io/

2，使用swagger要註意的地方:

     在生產環境中必須關閉swagger,

     它本身隻用於前後端工程師之間的溝通,

     可以專門使用一臺內部服務器來展示ui供訪問,

     即使在這上面要做好安全措施

3,  因為swagger3.0.0已發佈，本文使用瞭最新版

     如果有還在用2.x版本的請參考時註意區分

二，SpringBoot 集成swagger3

 pom.xml 集成Swagger3依賴

        <!-- swagger3 接口文檔生成器 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>3.0.0</version>
			<exclusions>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-core</artifactId>
				</exclusion>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-metadata</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

Swagger3 配置對象定義

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
 
@Configuration
@EnableOpenApi
public class Swagger3Config {
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.digipower.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("在奮鬥的大道上 - 微信預約查檔系統").termsOfServiceUrl("https://blog.csdn.net/zhouzhiwengang")
				.description("API接口")
				.contact(new Contact("https://blog.csdn.net/zhouzhiwengang","",""))
				.version("3.0").build();
    }
 
}

SpringBoot 集成Swagger3 接口文檔效果截圖

 SpringBoot 訪問Swagger3接口文檔地址

默認接口訪問地址:http://192.168.0.1:5988/swagger-ui/

三，swagger3 註解標簽使用

@ApiModel用於類上面說明功能

@ApiModelProperty用於字段上說明功能

示列截圖：

@Api用來指定一個controller中的各個接口的通用說明

@ApiOperation用來說明一個方法

@ApiImplicitParams:用來包含多個包含多個 @ApiImplicitParam

@ApiImplicitParam:用來說明一個請求參數 

示列截圖：

 溫馨提示：針對任何請求參數結構說明，請一定記得要添加@ApiParam 標簽，如果不添加@ApiParam標簽，在Swagger3文檔中針對參數結構說明就是空

到此這篇關於SpringBoot集成Swagger3的實現的文章就介紹到這瞭,更多相關SpringBoot集成Swagger3內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：