Zuul整合Swagger2
跟我走 swagger2不用愁！
效果图：
1.项目架构
basic-microservice 基础微服务 端口8080
user-center-microservice 用户微服务 端口8081
gateway-server 网关服务 端口8088
2.基础微服务配置
2.1 添加依赖
<dependency>
<groupId>io.springfoxgroupId>
<artifactId>springfox-swagger2artifactId>
<version>2.7.0version>
dependency>
<dependency>
<groupId>io.springfoxgroupId>
<artifactId>springfox-swagger-uiartifactId>
<version>2.7.0version>
dependency>2.2 创建配置类
package com.hzcf.basic.swagger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
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.swagger.web.UiConfiguration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
.apis(RequestHandlerSelectors.basePackage("com.hzcf.basic.controller"))
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("基础微服务api").description("基础微服务接口文档说明")
.version("1.0").build();
}
@Bean
UiConfiguration uiConfig() {
return new UiConfiguration(null, "list", "alpha", "schema", UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS,
false, true, 60000L);
}
}2.3 在BasicApplication启动类上添加
@EnableSwagger2
2.4 在需要生成的类或方法上加具体注解
详细注解含义如下：
@Api() 用于类；表示标识这个类是swagger的资源
tags–表示说明
value–也是说明，可以使用tags替代
@ApiOperation() 用于方法；表示一个http请求的操作
value用于方法描述
notes用于提示内容
@ApiParam() 用于方法，参数，字段说明；表示对参数的添加元数据（说明或是否必填等）
name–参数名
value–参数说明
required–是否必填
@ApiModel()用于类 ；表示对类进行说明，用于参数用实体类接收
value–表示对象名
@ApiModelProperty()用于方法，字段； 表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
@ApiImplicitParam() 用于方法
表示单独的请求参数
@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam
name–参数ming
value–参数说明
dataType–数据类型
paramType–参数类型
example–举例说明
@ApiIgnore
作用于方法上，使用这个注解swagger将忽略这个接口
3.网关微服务配置
3.1 添加同上maven依赖
略。。。3.2 创建配置类
package com.hzcf.gateway.swagger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger.web.UiConfiguration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("金融云平台")
.description("金融云平台接口文档说明")
.termsOfServiceUrl("http://localhost:8088")
.version("1.0")
.build();
}
@Bean
UiConfiguration uiConfig() {
return new UiConfiguration(null, "list", "alpha", "schema",
UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS, false, true, 60000L);
}
}3.3 创建资源配置类DocumentationConfig
package com.hzcf.gateway.swagger;
import java.util.ArrayList;
import java.util.List;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
import springfox.documentation.swagger.web.SwaggerResource;
import springfox.documentation.swagger.web.SwaggerResourcesProvider;
/**
*
*- 类名：DocumentationConfig.java
*- 描述: Swagger 资源文档配置类
*- 创建时间： 2018年8月8日 下午3:27:41
*- 创建人： TieGuowei
*- 版本历史:
*
* Date Author Version Description
* ------------------------------------------------------------------
* 2018年8月8日 下午3:27:41 TieGuowei 1.0 1.0 Version
*
*
*/
@Component
@Primary
public class DocumentationConfig implements SwaggerResourcesProvider{
@Override
public List get() {
List resources = new ArrayList<>();
resources.add(swaggerResource("基础微服务接口", "/basic/v2/api-docs", "1.0"));
resources.add(swaggerResource("用户微服务接口", "/user/v2/api-docs", "1.0"));
return resources;
}
private SwaggerResource swaggerResource(String name, String location, String version) {
SwaggerResource swaggerResource = new SwaggerResource();
swaggerResource.setName(name);
swaggerResource.setLocation(location);
swaggerResource.setSwaggerVersion(version);
return swaggerResource;
}
}
3.4 application.properties
server.port=8088
spring.application.name = gateway-server
#注册中心地址
eureka.client.serviceUrl.defaultZone=http://user:user123@localhost:8761/eureka/
#自定义微服务访问地址
#基础服务
zuul.routes.basic-microservice = /basic/**
#用户服务
zuul.routes.user-center-microservice = /user/**
3.5在GatewayApplication启动类上添加
@EnableSwagger2
4.用户微服务和基础微服务配置完全一样
步骤略。。。5 访问http://localhost:8088/swagger-ui.html
效果同上
点击方法名可以进行接口测试
