Swagger
主要看源码学习
导入依赖
<!-- 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>
swagger版本 3.0.0 与2.9.2 有些许的不同,如:访问swagger-ui.html的地址不同
配置swagger
package com.example.demo.config;
import com.google.common.base.Predicate;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.VendorExtension;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
@EnableSwagger2
@Configuration
public class SwaggerConfig {
@Value("${isActive}")
boolean isActive;
@Bean
public Docket d1(){
System.out.println("是否开启: "+isActive);
return new Docket(DocumentationType.SWAGGER_2)
.groupName("王顺")//分组的名字
.enable(isActive)//是否能够进入swagger.ui
.apiInfo(a1())//描述信息
.host("8089")
.select()
// 指定选择包下面的
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
// 扫描某个接口下的。。。。。
// .paths(PathSelectors.ant("/user/**"))
.build();
}
public ApiInfo a1(){
return new ApiInfo(
"题目",
"描述",
"test1.0",
"termsOfServiceUrl",
new Contact("contactName", "www.baidu.com", "1625809903@qq.com"),
"license",
"licenseUrl",
new ArrayList<VendorExtension>()
);
}
}
根据不同的环境决定是否开启swaggerui
.enable(Param)//false | true
由于环境的不同可以使用注解@Value获取配置文件中.yml中的值决定是否开启;
在swaggerUI中显示注释
- Api 【可以用于所有】
- ApiModel(“实体名字”) 【用于实体class上的注释】【只有有返回这个类型的时候swaggerUI中才会出现】
- ApiModelProperty(“属性名字”)【用于实体属性的注释】
- ApiOperation(“接口名字”)【用于接口的注解】
- ApiParam(“接口参数名字”)【用于接口上参数的注释】