淘东电商项目(05) - Swagger及网关统一管理API

简介: 淘东电商项目(05) - Swagger及网关统一管理API

引言

在上一节《淘东电商项目(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: xxxxxx@qq.com

最后在接口(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: xxxxxx@qq.com

最后在接口(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文档,比如选择“会员服务服务”的接口,如下:

在比如选择“微信服务项目”的接口,如下:

总结

目录
相关文章
|
1月前
|
数据采集 JSON API
如何实现高效率超简洁的实时数据采集?——Python实战电商数据采集API接口
你是否曾为获取重要数据而感到困扰?是否因为数据封锁而无法获取所需信息?是否因为数据格式混乱而头疼?现在,所有这些问题都可以迎刃而解。让我为大家介绍一款强大的数据采集API接口。
|
1月前
|
数据可视化 Linux API
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
|
1月前
|
API
阿里云微服务引擎及 API 网关 2024 年 2 月产品动态
阿里云微服务引擎及 API 网关 2024 年 2 月产品动态
|
1月前
|
数据采集 运维 数据挖掘
API电商接口大数据分析与数据挖掘 (商品详情店铺)
API接口、数据分析以及数据挖掘在商品详情和店铺相关的应用中,各自扮演着重要的角色。以下是关于它们各自的功能以及如何在商品详情和店铺分析中协同工作的简要说明。
|
2月前
|
Prometheus 网络协议 JavaScript
api 网关 kong 数据库记录请求响应报文
Kong的tcp-log-with-body插件是一个高效的工具,它能够转发Kong处理的请求和响应。这个插件非常适用于需要详细记录API请求和响应信息的情景,尤其是在调试和排查问题时。
49 0
api 网关 kong 数据库记录请求响应报文
|
2月前
|
数据采集 监控 算法
利用大数据和API优化电商决策:商品性能分析实践
在数据驱动的电子商务时代,大数据分析已成为企业提升运营效率、增强市场竞争力的关键工具。通过精确收集和分析商品性能数据,企业能够洞察市场趋势,实现库存优化,提升顾客满意度,并显著增加销售额。本文将探讨如何通过API收集商品数据,并将这些数据转化为对电商平台有价值的洞察。
|
2月前
|
数据采集 监控 测试技术
如何为数据采集项目选择合适的API
摘要: 在数据采集项目中,选择合适的API对于实现高效、可靠的数据集成至关重要。本文为技术人员和技术经理提供了一个综合指南,以便评估和选择满足特定业务需求的API。 引言: 在数字化转型的浪潮中,企业依靠数据驱动决策变得越来越重要。有效的数据采集策略可以提供深入的洞见,并推动业务增长。API作为连接不同服务和数据的桥梁,在此过程中扮演着关键角色。
|
2天前
|
前端开发 JavaScript API
React的Context API:全局状态管理的利器
【4月更文挑战第25天】React的Context API解决了深层组件间状态共享的难题,提供全局状态管理方案。通过`Provider`和`Consumer`组件,或结合`useContext` Hook,实现状态在组件树中的传递。最佳实践包括避免过度使用,分离逻辑,以及在必要时与Redux或MobX结合。Context API简化了数据传递,但需谨慎使用以保持代码清晰。
|
11天前
|
API
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态。
|
1月前
|
JSON Java API
Springboot项目中如何设计一个规范的统一的Restful API 响应框架?
Springboot项目中如何设计一个规范的统一的Restful API 响应框架?
23 1