springcloud - 使用knife4j聚合微服务接口文档

简介: springcloud - 使用knife4j聚合微服务接口文档

一、介绍

在使用微服务架构开发的过程中,由于每个微服务都是独立的,因此很多开发人员在提供接口文档时,针对每一个服务也提供了独立的接口文档,

在使用容器部署的环境中缺点也更加突出,本来每一个服务容器都是通过网关访问的,它自身的ip和端口号并不被暴露出去,但是在容器部署环境下,我们不得不将服务容器的端口与主机端口进行绑定,通过主机ip+端口号访问接口文档。

在微服务环境下,不同服务的接口都是经过网关gateway作为统一入口进行转发访问的,因此不同服务的接口文档也应该有一个统一的入口。

那么有没有合适的方案,通过统一的入口,将各个微服务的接口文档进行聚合呢?答案是有的。

  • 方案一:通过网关对各个微服务的接口文档进行聚合。这样我们只需要通过访问网关就可以得到所有微服务的接口文档了。
  • 方案二:通过独立的微服务(称为接口文档微服务),该服务从注册中心中获取其他微服务,然后我们通过访问接口文档微服务就可以得到所有微服务的接口文档了。

而且巧的是,knife4j已经帮我们把这两种方案都实现了,我们通过demo对这两种方案进行演示。

二、不使用聚合文档

新建两个微服务:

  • student-service

    • 在pom中引入依赖knife4j-spring-boot-starter

      单体架构下的pom依赖.png

    • 配置文件

      单体架构下学生服务配置.png

    • 新建Knife4jConfiguration配置文件,对knife4j进行配置

      单体架构下学生服务knife4j的配置.png

    • 添加接口BoyStudentControllerGirlStudentController

      男学生Controller.png

      女学生Controller.png

    • 通过http://localhost:8001/student/doc.html访问接口文档

      单体架构学生服务接口文档.png

  • teacher-service

    • 在pom中引入依赖knife4j-spring-boot-starter

      单体架构下的pom依赖.png

    • 配置文件

      单体架构下教师服务配置.png

    • 新建Knife4jConfiguration配置文件,对knife4j进行配置

      单体架构下教师服务knife4j的配置.png

    • 添加接口ChinessTeacherControllerEnglishTeacherController

      语文教师Controller.png

      英语教师Controller.png

    • 通过http://localhost:8002/teacher/doc.html访问接口文档

      单体架构教师服务接口文档.png


不同的服务需要不同的地址访问,在微服务环境下,如果还是这样而没有统一的入口,那前端同事可能早就吃你的鱼了。

三、gateway网关聚合接口文档

在微服务环境中,网关作为各个服务的统一入口。因此可以考虑把网关也作为各个服务接口文档的统一入口。同时注册中心也是必不可少的。

student-serviceteacher-service两个服务的基础上,我们添加网关注册中心,注册中心我们以eureka为例

1. 新建eureka注册中心微服务eureka-server

  • 在pom中引入依赖

    eureka注册中心依赖.png

  • 配置文件

    eureka注册中心配置文件.png

  • 启动类

    eureka注册中心主启动.png

  • 访问注册中心,http://localhost:9001/eureka/

    eureka注册中心.png

2. 修改微服务

  • student-serviceteacher-service微服务添加pom依赖

    微服务+eureka+knife4j依赖.png

  • 修改文档配置类

    微服务架构下文档配置.png

  • 配置注册中心

    微服务对注册中心的配置.png

  • 每个微服务主启动添加注解@EnableDiscoveryClient

    微服务添加服务发现注解.png

  • 启动student-serviceteacher-service微服务后查看eureka注册中心

    eureka注册中心+两个微服务.png

3. 新建网关服务gateway-service

  • 在pom中引入依赖knife4j-spring-boot-starter

    gateway+eureka+knife4j依赖.png

  • 路由配置

    网关路由配置.png

  • 文档聚合配置

    • 资源配置

      网关knife4j资源配置.png

  • 处理器配置

    网关knife4j处理器.png

  • 主启动类

    网关主启动.png

  • 打开eureka注册中心,查看网关是否注册成功

    eureka注册中心+微服务+网关.png

  • 通过网关访问接口文档。http://localhost:9002/doc.html

    在接口文档的左上角有个下拉框,里面是我们在网关中配置的路由,在下拉框选择不同的项目,可以看到不同微服务的接口文档。

    网关查看student接口文档.png


网关查看teacher接口文档.png

四、使用独立的接口文档服务

前面我们介绍的是通过网关gateway聚合微服务接口文档,但这种方案对网关存在一定的侵入。下面我们介绍通过注册中心聚合微服务接口文档,

1. 新建接口文档微服务

  • pom文件添加依赖

    aggregation服务pom依赖.png

  • 配置文件

    aggregation服务配置文件.png

  • 启动类

    aggregation服务启动类.png

2. 启动接口文档微服务

启动服务后,通过该服务的ip和端口号,访问接口文档。如http://localhost:9003/knife4j/doc.html

可以看到,通过独立的服务聚合其他微服务接口文档这种方式更加简单,快速。

aggregation服务效果图.png

3.通过网关访问接口文档微服务

  • 在网关的配置文件中设置路由

    网关添加aggregation服务的路由.png

  • 通过网关访问接口文档

    地址:http://localhost:9002/knife4j/doc.html

    网关访问knife4j接口文档服务.png

到此为止,微服务架构下聚合微服务接口文档的两种方式我们都介绍完了,

下期再见。




纸上得来终觉浅,绝知此事要躬行。

————————————————我是万万岁,我们下期再见————————————————

相关文章
|
23天前
|
Dubbo Java 应用服务中间件
Spring Cloud Dubbo:微服务通信的高效解决方案
【10月更文挑战第15天】随着信息技术的发展,微服务架构成为企业应用开发的主流。Spring Cloud Dubbo结合了Dubbo的高性能RPC和Spring Cloud的生态系统,提供高效、稳定的微服务通信解决方案。它支持多种通信协议,具备服务注册与发现、负载均衡及容错机制,简化了服务调用的复杂性,使开发者能更专注于业务逻辑的实现。
46 2
|
2月前
|
Java 对象存储 开发者
解析Spring Cloud与Netflix OSS:微服务架构中的左右手如何协同作战
Spring Cloud与Netflix OSS不仅是现代微服务架构中不可或缺的一部分,它们还通过不断的技术创新和社区贡献推动了整个行业的发展。无论是对于初创企业还是大型组织来说,掌握并合理运用这两套工具,都能极大地提升软件系统的灵活性、可扩展性以及整体性能。随着云计算和容器化技术的进一步普及,Spring Cloud与Netflix OSS将继续引领微服务技术的发展潮流。
49 0
|
26天前
|
Dubbo Java 应用服务中间件
Dubbo学习圣经:从入门到精通 Dubbo3.0 + SpringCloud Alibaba 微服务基础框架
尼恩团队的15大技术圣经,旨在帮助开发者系统化、体系化地掌握核心技术,提升技术实力,从而在面试和工作中脱颖而出。本文介绍了如何使用Dubbo3.0与Spring Cloud Gateway进行整合,解决传统Dubbo架构缺乏HTTP入口的问题,实现高性能的微服务网关。
|
23天前
|
JSON Java 数据格式
【微服务】SpringCloud之Feign远程调用
本文介绍了使用Feign作为HTTP客户端替代RestTemplate进行远程调用的优势及具体使用方法。Feign通过声明式接口简化了HTTP请求的发送,提高了代码的可读性和维护性。文章详细描述了Feign的搭建步骤,包括引入依赖、添加注解、编写FeignClient接口和调用代码,并提供了自定义配置的示例,如修改日志级别等。
55 1
|
26天前
|
人工智能 文字识别 Java
SpringCloud+Python 混合微服务,如何打造AI分布式业务应用的技术底层?
尼恩,一位拥有20年架构经验的老架构师,通过其深厚的架构功力,成功指导了一位9年经验的网易工程师转型为大模型架构师,薪资逆涨50%,年薪近80W。尼恩的指导不仅帮助这位工程师在一年内成为大模型架构师,还让他管理起了10人团队,产品成功应用于多家大中型企业。尼恩因此决定编写《LLM大模型学习圣经》系列,帮助更多人掌握大模型架构,实现职业跃迁。该系列包括《从0到1吃透Transformer技术底座》、《从0到1精通RAG架构》等,旨在系统化、体系化地讲解大模型技术,助力读者实现“offer直提”。此外,尼恩还分享了多个技术圣经,如《NIO圣经》、《Docker圣经》等,帮助读者深入理解核心技术。
SpringCloud+Python 混合微服务,如何打造AI分布式业务应用的技术底层?
|
1月前
|
监控 Java 对象存储
监控与追踪:如何利用Spring Cloud Sleuth和Netflix OSS工具进行微服务调试
监控与追踪:如何利用Spring Cloud Sleuth和Netflix OSS工具进行微服务调试
41 1
|
2月前
|
负载均衡 Java 网络架构
实现微服务网关:Zuul与Spring Cloud Gateway的比较分析
实现微服务网关:Zuul与Spring Cloud Gateway的比较分析
92 5
|
2月前
|
前端开发 API 微服务
SpringCloud微服务之间使用Feign调用不通情况举例
SpringCloud微服务之间使用Feign调用不通情况举例
449 2
|
1月前
|
负载均衡 算法 Nacos
SpringCloud 微服务nacos和eureka
SpringCloud 微服务nacos和eureka
57 0
|
2月前
|
Java 对象存储 开发者
微服务世界的双雄争霸:Spring Cloud与Netflix OSS——谁将引领下一次企业级应用变革的风暴?
Spring Cloud与Netflix OSS是微服务架构的核心组件集,分别以其与Spring Boot的紧密集成及为大规模分布式系统设计的特性,在Java开发社区中广受青睐。前者通过Eureka提供服务发现机制,简化服务注册与定位;后者借助Hystrix增强系统弹性和可靠性,避免雪崩效应。此外,二者还包含负载均衡(Ribbon)、声明式HTTP客户端(Feign)及API网关(Zuul)等功能,共同构建强大微服务体系,助力开发者聚焦业务逻辑,提升系统灵活性与性能。
44 0