1)引用依赖
<properties>
<myswagger.version>2.9.2</myswagger.version>
</properties>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${myswagger.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${myswagger.version}</version>
</dependency>
2)新建SwaggerConfig
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.api.controller")) // 指定包 剔除basic-error-controller
.paths(PathSelectors.any())
.build()
.globalOperationParameters(globalOperation());
}
/**
* 接口信息 *
* @return api描述信息
*/
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("测试接口Swagger文档")
.contact(new Contact("测试","http://127.0.0.1:8883","121212@qq.com"))
.version("1.0")
.description("测试接口。。。。。。。")
.build();
}
/**
* token*
* @return token信息
*/
private List<Parameter> globalOperation(){
ParameterBuilder builder=new ParameterBuilder();
List<Parameter> parameters=new ArrayList<>();
builder.name("Authorization")
.description("token令牌")
.modelRef(new ModelRef("String"))
.parameterType("header")
.required(true)
.build();
parameters.add(builder.build());
return parameters;
}
}
3)接口注释
@RequestMapping("/api/test")
@RestController
@Api(tags = "测试服务接口")
public class TestController {
@Value("${test}")
private String test;
@ApiOperation("获取测试信息")
@GetMapping("/GetTestRequest")
public String getTestRequest(){
return test;
}
}
4)效果