淘东电商项目(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文档,比如选择“会员服务服务”的接口,如下:

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

总结

目录
相关文章
|
13天前
|
数据采集 监控 搜索推荐
深度解析淘宝商品详情API接口:解锁电商数据新维度,驱动业务增长
淘宝商品详情API接口,是淘宝开放平台为第三方开发者提供的一套用于获取淘宝、天猫等电商平台商品详细信息的应用程序接口。该接口涵盖了商品的基本信息(如标题、价格、图片)、属性参数、库存状况、销量评价、物流信息等,是电商企业实现商品管理、市场分析、营销策略制定等功能的得力助手。
|
1月前
|
搜索推荐 数据挖掘 API
电商发展的强大助推器:淘宝API
淘宝API是阿里巴巴为开发者提供的访问淘宝开放平台(TOP)的接口,连接淘宝电商生态系统与外部应用。它支持商品管理、订单处理、用户信息和营销推广等功能,帮助开发者轻松获取商品信息、处理订单、管理会员和进行数据分析。通过淘宝API,电商企业能提高效率、降低成本、增加收入并优化用户体验。其应用广泛,涵盖电商平台建设、价格比较、市场研究及移动应用开发等领域。未来,淘宝API将融合人工智能、拓展生态合作并加强数据安全,持续推动电商行业发展。
175 34
|
24天前
|
存储 缓存 API
电商行业中 API 接口的常见问题和解决方法
本文探讨了电商行业中API接口的常见问题及解决方法。涵盖数据准确性(如数据不一致、数据缺失)、性能问题(如响应时间过长、吞吐量不足)、安全问题(如身份认证与授权、数据泄露风险)和兼容性问题(如接口版本兼容性、系统兼容性)。通过优化数据同步机制、缓存策略、网络配置、服务器负载均衡、代码逻辑,以及采用安全的身份认证方式和加密技术,结合实际代码示例,帮助开发者提升API接口的稳定性和安全性,确保电商业务顺利运行。
79 11
|
24天前
|
前端开发 安全 数据挖掘
在电商行业中 API 是什么意思?
在电商行业飞速发展的当下,API(应用程序编程接口)作为支撑各类应用高效运转的关键技术,扮演着不可或缺的角色。无论是商品展示、订单处理还是物流跟踪,API 都是连接不同系统和服务的桥梁。本文将详细阐述电商行业中 API 的概念、类型(如 RESTful、SOAP 和 GraphQL)、应用场景(如商品管理、订单处理、物流跟踪和数据分析),并通过代码示例展示其实际应用。掌握 API 知识,有助于电商从业者推动业务创新,在竞争中占据优势。
62 12
|
23天前
|
搜索推荐 测试技术 API
探秘电商API:从测试到应用的深度解析与实战指南
电商API是电子商务背后的隐形引擎,支撑着从商品搜索、购物车更新到支付处理等各个环节的顺畅运行。它通过定义良好的接口,实现不同系统间的数据交互与功能集成,确保订单、库存和物流等信息的实时同步。RESTful、GraphQL和WebSocket等类型的API各自适用于不同的应用场景,满足多样化的需求。在测试方面,使用Postman、SoapUI和jMeter等工具进行全面的功能、性能和安全测试,确保API的稳定性和可靠性。未来,随着人工智能、大数据和物联网技术的发展,电商API将进一步智能化和标准化,为用户提供更个性化的购物体验,并推动电商行业的持续创新与进步。
55 4
|
30天前
|
JSON 缓存 API
解析电商商品详情API接口系列,json数据示例参考
电商商品详情API接口是电商平台的重要组成部分,提供了商品的详细信息,支持用户进行商品浏览和购买决策。通过合理的API设计和优化,可以提升系统性能和用户体验。希望本文的解析和示例能够为开发者提供参考,帮助构建高效、可靠的电商系统。
39 12
|
1月前
|
供应链 搜索推荐 API
深度解析1688 API对电商的影响与实战应用
在全球电子商务迅猛发展的背景下,1688作为知名的B2B电商平台,为中小企业提供商品批发、分销、供应链管理等一站式服务,并通过开放的API接口,为开发者和电商企业提供数据资源和功能支持。本文将深入解析1688 API的功能(如商品搜索、详情、订单管理等)、应用场景(如商品展示、搜索优化、交易管理和用户行为分析)、收益分析(如流量增长、销售提升、库存优化和成本降低)及实际案例,帮助电商从业者提升运营效率和商业收益。
190 20
|
1月前
|
供应链 API 开发者
解锁电商数据的无限可能:探秘京东商品SKU信息API接口
京东商品SKU信息API接口是电商开发与运营中的重要工具,帮助开发者获取商品的详细属性,如库存、价格、规格等。通过该接口,电商平台可以丰富商品展示页面,提升用户体验;商家能实时掌握库存动态,优化销售策略;数据分析人员可深入洞察市场趋势,实现精准营销。使用前需注册京东开放平台账号、创建应用并获取API权限,同时仔细阅读API文档以确保正确调用。代码示例展示了如何用Python调用该接口,并处理返回数据。未来,该接口将在个性化推荐、智能库存管理和数据分析等领域发挥更大作用,助力电商业务创新与发展。
95 14
|
26天前
|
前端开发 安全 数据挖掘
在电商行业中 API 是什么意思?
在电商行业飞速发展的今天,API(应用程序编程接口)作为支撑各类应用高效运转的关键技术,扮演着不可或缺的角色。本文详细阐述了电商行业中API的概念、类型及应用场景,包括商品信息管理、订单处理、物流跟踪和数据分析与推荐等环节,并通过代码示例展示了其实际应用。随着技术进步,API的安全性和智能化将成为未来发展趋势,助力电商创新和业务拓展。掌握API知识,有助于从业者在竞争中占据优势。
45 0
|
1月前
|
搜索推荐 数据挖掘 API
阿里巴巴API接口对电商的影响与收益
在全球电子商务快速发展的背景下,阿里巴巴作为领先的B2B平台,为中小企业提供商品批发、分销、供应链管理等一站式服务,并通过开放的API接口为开发者和电商企业提供数据资源与功能支持。本文将深入解析阿里巴巴API接口的功能(如商品搜索、详情、订单和用户管理)、应用(如商品展示、搜索优化、交易管理和用户行为分析)、收益(如流量增长、销售提升、库存优化)及实际案例,附带代码示例,助力电商从业者提升运营效率和用户体验。
67 0

热门文章

最新文章