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

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

下期再见。




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

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

相关文章
|
1月前
|
SpringCloudAlibaba Java 持续交付
【构建一套Spring Cloud项目的大概步骤】&【Springcloud Alibaba微服务分布式架构学习资料】
【构建一套Spring Cloud项目的大概步骤】&【Springcloud Alibaba微服务分布式架构学习资料】
169 0
|
5天前
|
Java 数据安全/隐私保护 Sentinel
微服务学习 | Spring Cloud 中使用 Sentinel 实现服务限流
微服务学习 | Spring Cloud 中使用 Sentinel 实现服务限流
|
5天前
|
运维 监控 Java
SpringCloud&认识微服务
SpringCloud&认识微服务
|
13天前
|
负载均衡 Java 开发者
细解微服务架构实践:如何使用Spring Cloud进行Java微服务治理
【4月更文挑战第17天】Spring Cloud是Java微服务治理的首选框架,整合了Eureka(服务发现)、Ribbon(客户端负载均衡)、Hystrix(熔断器)、Zuul(API网关)和Config Server(配置中心)。通过Eureka实现服务注册与发现,Ribbon提供负载均衡,Hystrix实现熔断保护,Zuul作为API网关,Config Server集中管理配置。理解并运用Spring Cloud进行微服务治理是现代Java开发者的关键技能。
|
22天前
|
SpringCloudAlibaba 监控 Java
SpringCloud Alibaba微服务-- Sentinel的使用(保姆级)
SpringCloud Alibaba微服务-- Sentinel的使用(保姆级)
|
22天前
|
SpringCloudAlibaba Java API
SpringCloud Alibaba微服务工程搭建(保姆级)
SpringCloud Alibaba微服务工程搭建(保姆级)
|
22天前
|
SpringCloudAlibaba Java Nacos
SpringCloud Alibaba微服务 -- Nacos使用以及注册中心和配置中心的应用(保姆级)
SpringCloud Alibaba微服务 -- Nacos使用以及注册中心和配置中心的应用(保姆级)
|
28天前
|
负载均衡 网络协议 Java
构建高效可扩展的微服务架构:利用Spring Cloud实现服务发现与负载均衡
本文将探讨如何利用Spring Cloud技术实现微服务架构中的服务发现与负载均衡,通过注册中心来管理服务的注册与发现,并通过负载均衡策略实现请求的分发,从而构建高效可扩展的微服务系统。
|
1月前
|
SpringCloudAlibaba 负载均衡 Java
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(目录大纲)
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(目录大纲)
68 1
|
1月前
|
Java Nacos Sentinel
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(九)Nacos+Sentinel+Seata
【Springcloud Alibaba微服务分布式架构 | Spring Cloud】之学习笔记(九)Nacos+Sentinel+Seata
212 0