gateway整合knife4j(微服务在线文档)


knife4j 微服务整合

由于单个服务的knife4j 整合之前已经写过了,那么由于效果比较好,然后微服务的项目中也想引入,所以开始微服务的这个之路;


一、微服务与单体项目文档整合的区别

  1. 微服务中一般使用gateway作为统一路由(或者zuul), 单体项目不会使用
  2. 微服务中的各个服务的文档分布在多个中,不像单体项目都在一个位置
  3. 在线文档要统一所有接口,然后形成全量文档,所以需要整合各个微服务的接口到一起

二、开始整合

1. 搭建一个父子maven模块的微服务,并引入gateway

具体如何搭建,就不详细说了,感兴趣可以看看项目就好了 项目git地址

  • 注册中心: nacos
  • 路由: gateway

2.开始整合文档

主要参考的文章是 knife4j的官方文档
整合后的样子
问题汇总

虽然实现了服务的聚合,文档也ok了,但是对于微服务的自定义前缀(项目名),这里的结构是对的,但是访问接口是错误的,不会加前缀
即使配置了 也不行 filters: - SwaggerHeaderFilter - StripPrefix=1
我项目中的版本与这个版本有一点差异也有可能是这个问题导致的


总结

下次我要尝试用zuul,因为knife4j的官网文档上说,zuul就不会有这个问题;

官网文档

失败了,我整合了zuul 发现根本就不行,应该还是版本问题,先这样吧,zuul 不弄了~~~

  • 2
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
Spring Boot是一种便捷的框架,它可以快速地搭建Java应用程序,并且它对于集成其他组件和框架也十分方便。而Knife4j则是一种集成度很高的API文档工具,它可以将接口文档在Swagger的基础上大幅度优化。在Spring Boot中使用Knife4j整合API文档也非常简单。 首先,我们需要在Spring Boot的项目中引入Knife4j依赖,可以在pom.xml文件中加入以下代码: ``` <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.2.7</version> </dependency> ``` 这样Knife4j就会被自动集成到Spring Boot的应用中。 接下来,我们需要在Controller方法上增加注解,并且配置一些信息才能生成接口文档。 ``` @GetMapping("/hello") @ApiOperation(value = "示例API接口", notes = "这是一个示例API接口") @ApiImplicitParams({ @ApiImplicitParam(name = "name", value = "用户名", required = true, dataType = "String", paramType = "header") }) public String hello(@RequestHeader String name){ return "Hello, " + name + "!"; } ``` 其中@GetMapping是Spring Boot的注解,用于标记这是一个GET请求。@ApiOperation和@ApiImplicitParams则是Knife4j的注解,它们分别用于注释方法和方法参数的信息。 最后,在启动Spring Boot应用后,访问http://localhost:8080/doc.html 就可以看到生成的接口文档了。这个文档列表会列出所有接口的URL、HTTP方法、请求参数、响应结果等信息,非常直观和有用。通过Knife4j可以使API文档生成更加高效、直观,方便开发者理解和调用接口。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

寂寞旅行

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值