版本號
框架 | 版本號 |
---|---|
spring boot | 2.2.1.RELEASE |
swagger-ui | 2.6.1 |
引入maven依賴
引入swagger的maven依賴,可以引入新版本的swagge2r,具體使用方式沒有大的變化,只是頁面UI更加美觀了
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
配置
添加java配置
import io.swagger.annotations.ApiOperation;
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.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;
/**
* @Author: 俞兆鵬
* @Date: 2019/5/21 17:26
* @Email: [email protected]
* @Version 1.0
*/
@Configuration
@EnableSwagger2
public class Swagger2Config {
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//掃描所有有註解的api,用這種方式更靈活
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build()
.enable(true)
.useDefaultResponseMessages(false);
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("代碼生成平臺API文檔")
.description("接口由swagger2.6.1生成")
.termsOfServiceUrl("http://52.83.137.110")
.version("1.0.0")
.build();
}
}
使用方法
- 在controller上標記
import com.puhua.platform.entity.Test;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @Author: 俞兆鵬
* @Date: 2019/12/2 16:00
* @Email: [email protected]
* @Version 1.0
*/
@Api(description = "測試控制器", tags = {"HelloController"})
@RestController
@RequestMapping("/api")
public class HelloController {
@ApiOperation(value = "測試接口",notes= "這是一個測試接口")
@ApiImplicitParams({
@ApiImplicitParam(name = "testParam", value = "這是一個測試參數(方法參數)", dataType = "string", paramType = "query", required = false),
})
@GetMapping("/hello")
public String hello(String testParam, Test testEntity){
return "hello";
}
}
- 實體類上標記
/**
* @author 俞兆鵬
* @since 2019-12-02
*/
@Data
@ApiModel(value="Test對象", description="實體類對象")
public class Test implements Serializable {
private static final long serialVersionUID=1L;
//在swagger上隱藏這個字段
@ApiModelProperty(value = "id",hidden = true)
private Integer id;
@ApiModelProperty(value = "姓名(實體類參數)")
private String name;
}
訪問swagger地址
訪問
http://localhost:8183/swagger-ui.html
備註
詳細說明參考swagger官網