引言
在上一节《淘东电商项目（04） - 注册中心及Feign远程调用》主要讲解了注册中心以及使用Feign远程调用。
代码已提交至Github（版本号：
8e89a7b9c7d01685c45f11f545449d95ede0293b），有兴趣的同学可以下载来看看： https://github.com/ylw-github/taodong-shop
本文将开始讲解使用Swagger管理每个微服务的API，并使用网关来进行统一管理。
本文目录结构：
l____引言
l____ 1. 微服务整合Swagger
l________1.1 配置接口层的Maven
l________1.2 配置会员服务
l________1.3 配置微信服务
l____ 2. 网关统一管理API
l________2.1 Maven依赖
l________2.2 统一管理API代码
l________2.3 配置
l____ 3. 测试
l________3.1 验证单个服务swagger
l________3.2 验证网关整合后的swagger
l____总结
1. 微服务整合Swagger
下面来讲解配置微信服务和会员服务的API Swagger管理，然后整合到网关来实现API的统一管理。
1.1 配置接口层的Maven
配置taodong-shop-service-api的maven文件，添加swagger依赖：
<!-- swagger-spring-boot -->
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.7.0.RELEASE</version>
</dependency>
1.2 配置会员服务
首先要开启swagger开启配置文件，在会员服务（taodong-shop-service-member）的启动类添加注解@EnableSwagger2Doc:
@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
@EnableSwagger2Doc
public class AppMember {
public static void main(String[] args) {
SpringApplication.run(AppMember.class, args);
}
}
然后在配置文件添加swagger描述（可选）：
####swagger相关配置
swagger:
base-package: com.ylw.taodong
title: 淘东电商项目-会员服务接口
description: 该项目“基于SpringCloud2.x构建微服务电商项目。
version: 1.1
terms-of-service-url: www.xxx.com
contact:
name: 杨林伟
email: [email protected]
最后在接口（taodong-shop-service-api-member）添加Swagger文档注解描述：
@Api(tags = "会员服务接口")
public interface MemberService {
@ApiOperation(value = "会员服务调用微信服务")
@GetMapping("/memberInvokWeixin")
public AppEntity memberInvokWeixin();
}
1.3 配置微信服务
配置微信服务与配置会员服务的流程导致一致。
首先要开启swagger开启配置文件，在微信服务（taodong-shop-service-weixin）的启动类添加注解@EnableSwagger2Doc:
@SpringBootApplication
@EnableEurekaClient
@EnableSwagger2Doc
public class AppWeiXin {
public static void main(String[] args) {
SpringApplication.run(AppWeiXin.class, args);
}
}
然后在配置文件添加swagger描述（可选）：
####swagger相关配置
swagger:
base-package: com.ylw.taodong
title: 淘东电商项目-微信服务接口
description: 该项目“基于SpringCloud2.x构建微服务电商项目。
version: 1.1
terms-of-service-url: www.xxx.com
contact:
name: 杨林伟
email: [email protected]
最后在接口（taodong-shop-service-api-weixin）添加Swagger文档注解描述：
@Api(tags = "微信服务接口")
public interface AppService {
@ApiOperation(value = "微信应用服务接口")
@GetMapping("/getApp")
public AppEntity getApp();
}
2. 网关统一管理API
模块定位到taodong-shop-basics-zuul。
2.1 Maven依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
<!-- swagger-spring-boot -->
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.7.0.RELEASE</version>
</dependency>
2.2 统一管理API代码
配置启动类开启Swagger，并配置每个子Swagger的相关内容，如下：
@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
@EnableSwagger2Doc
public class AppGateWay {
public static void main(String[] args) {
SpringApplication.run(AppGateWay.class, args);
}
// 添加文档来源
@Component
@Primary
class DocumentationConfig implements SwaggerResourcesProvider {
@Override
public List<SwaggerResource> get() {
List resources = new ArrayList<>();
// 网关使用服务别名获取远程服务的SwaggerApi
resources.add(swaggerResource("taodong-shop-service-member", "/taodong-shop-service-member/v2/api-docs", "2.0"));
resources.add(swaggerResource("taodong-shop-service-weixin", "/taodong-shop-service-weixin/v2/api-docs", "2.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;
}
}
}
2.3 配置
###服务启动端口号
server:
port: 80
###服务名称(服务注册到eureka名称)
spring:
application:
name: taodong-shop-basics-zuul
###服务注册到eureka地址
eureka:
client:
service-url:
defaultZone: http://localhost:8100/eureka
3. 测试
3.1 验证单个服务swagger
1.启动Eureka注册中心服务（AppEureka），启动后浏览器输入：http://localhost:8100/，可以看到如下：
2.启动会员服务（AppMember）
3.启动微信服务（AppWeixin）
4.验证会员服务，浏览器输入：http://localhost:8300/swagger-ui.html#/，可以看到swagger管理的接口内容如下：
6.验证微信服务，浏览器输入：http://localhost:8200/swagger-ui.html#/，可以看到swagger管理的接口内容如下：
3.2 验证网关整合后的swagger
最后我们来启动网关服务（AppGateWay）,然后浏览器输入
http://localhost/swagger-ui.html#/，在如下界面，可以看到可以选择查看项目的API文档，比如选择“会员服务服务”的接口，如下：
在比如选择“微信服务项目”的接口，如下：
总结
