SpringCloud单个服务集成Swagger
一:引入依赖【哪个服务集成Swagger哪个引入】
<!--引入swagger支持-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
二:Swagger配置类【需要修改控制层全限定名】
@Configuration
@EnableSwagger2
public class Swagger2Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//对外暴露服务的包,以controller的方式暴露,所以就是controller的包.
.apis(RequestHandlerSelectors.basePackage("cn.itsource.web.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("管理系统")
.description("管理系统接口文档说明")
.contact(new Contact("whale.chen", "", "whale.chen@itsource.cn"))
.version("1.0")
.build();
}
}
相关注解:
a. controller增加 : @Api(value = "接口名",description = "描述")
b. 方法上增加 :@ApiOperation(value = "方法名",notes = "备注",response = JSONResult.class)
c. 参数前增加:@ApiParam(name = "参数名",required = true)
测试:访问localhost:当前服务的端口/swagger-ui.html