spring cloud 引入swagger
一、引入依赖
在build.gradle文件中的dependencies的对象中引入依赖
compile 'io.springfox:springfox-swagger2:2.9.2'
compile 'io.springfox:springfox-swagger-ui:2.9.2'
二、应用启动类,添加注解
@EnableSwagger2
@EnableSwagger2
@SpringBootApplication
public class ShopApplication {
public static void main(String[] args) {
SpringApplication.run(ShopApplication.class, args);
}
}
三、Swagger配置类
package com.pd.shop.config;
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;
@Configuration()
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.groupName("分组")
.apiInfo(apiInfo())
.select()
//指定接口controller文件夹 RequestHandlerSelectors.basePackage("com.pd.shop.controller")
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("标题")
.description("描述")
//服务团队地址
.termsOfServiceUrl("https://preparedata.blog.csdn.net/")
//.extensions()
.contact("联系人")
.version("版本号:0.1")
.build();
}
}
四、访问地址 + /swagger-ui.html
localhost:8080/swagger-ui.html
五、测试类
package com.pd.shop.controller;
import io.swagger.annotations.Api;
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;
@Api(value = "测试类", tags = "测试类")
@RestController
@RequestMapping("/v1/testApi")
public class TestApiController {
@GetMapping("/test")
@ApiOperation(value = "测试接口", httpMethod = "GET")
public String test(){
return "aaaa";
}
}