spring boot——整合swagger——入門示例
阿新 • • 發佈：2022-05-29
主要新增依賴如下：
<!--新增Swagger依賴 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!--新增Swagger-UI依賴 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
pom檔案：
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.2.6.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.mohai.one</groupId> <artifactId>springboot-swagger</artifactId> <version>0.0.1-SNAPSHOT</version> <name>springboot-swagger</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--新增Swagger依賴 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!--新增Swagger-UI依賴 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> <exclusions> <exclusion> <groupId>org.junit.vintage</groupId> <artifactId>junit-vintage-engine</artifactId> </exclusion> </exclusions> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
application.properties配置檔案：
spring.swagger.enable=true
SwaggerConfig配置檔案：
package com.mohai.one.springbootswagger.config; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 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.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * @Auther: [email protected] * @Date: 2020/7/17 23:20 */ @Configuration @EnableSwagger2 //宣告啟動Swagger2 //宣告屬性是否可用 @ConditionalOnProperty(name = "spring.swagger.enable", havingValue = "true", matchIfMissing=true) public class SwaggerConfig { /** * 注入 Docket，新增掃描的包路徑 * * @return */ @Bean public Docket customDocket() { return new Docket(DocumentationType.SWAGGER_2) //ApiInfo用於描述Api檔案的基礎資訊 .apiInfo(new ApiInfoBuilder() //標題 .title("Swagger2文件") //描述 .description("Rest風格介面") //版本號 .version("1.0.0") .build()) .select() //定義掃描的swagger介面包路徑 .apis(RequestHandlerSelectors.basePackage("com.mohai.one.springbootswagger.controller")) //所有路徑都滿足這個條件 .paths(PathSelectors.any()) .build(); } }
UserDTO
package com.mohai.one.springbootswagger.domain; import com.fasterxml.jackson.annotation.JsonFormat; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.util.Date; /** * @Auther: [email protected] * @Date: 2020/7/18 00:18 */ @ApiModel(description="使用者物件user") public class UserDTO { @ApiModelProperty(value="使用者id") private int id;
@ApiModelProperty(value="使用者名稱",name="username") private String username;
@ApiModelProperty(value="登入時間") @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") private Date loginTime;
public int getId() { return id; } public void setId(int id) { this.id = id; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public Date getLoginTime() { return loginTime; } public void setLoginTime(Date loginTime) { this.loginTime = loginTime; } }
IndexController
package com.mohai.one.springbootswagger.controller; import com.mohai.one.springbootswagger.domain.UserDTO; import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RestController; import java.util.Date; /** * @Auther: [email protected] * @Date: 2020/7/17 23:20 */ @RestController @Api("頁面首頁") public class IndexController { @ApiOperation("歡迎頁面") @GetMapping("/index") @ApiImplicitParam(name = "name",value = "姓名",dataType = "String") public String index(String name){ return "Welcome " + name + " to my site"; } @ApiOperation("更新使用者資訊") @PostMapping("/updateUserInfo") public UserDTO updateUserInfo(@RequestBody @ApiParam(name="使用者物件",value="傳入json格式",required=true) UserDTO user){ UserDTO userDTO = new UserDTO(); userDTO.setId(user.getId()); userDTO.setUsername("test"); userDTO.setLoginTime(new Date()); return userDTO; } }
http://localhost:8080/swagger-ui.html#/