支持国产,开源微服务架构项目之Knife4j使用

时间:2024-03-20 21:12:12

欢迎关注转发留言。想获取学习资料关注微信公众号(IT小分享),回复 学习即可!

今天看到了一条新闻,docker禁止国内被列入黑名单的公司使用了。IT行业未来一些广泛使用的技术会不会也被禁用呢?支持国产技术,势在必行!

这次介绍一款国产开源Api文档接口生成技术-Knife4j。这款产品与swgger相比有以下优势,友好界面,离线文档,接口排序,安全控制,在线调试,文档清晰,容易上手。废话不多说,上界面比对。Knife4J官网(https://doc.xiaominfo.com)

1 Knife4J界面 PK swagger界面

 

支持国产,开源微服务架构项目之Knife4j使用Knife4J界面

 

支持国产,开源微服务架构项目之Knife4j使用swagger界面

 

2 Knife4J 在开源微服务架构项目的使用.

Ruoyi-cloud(不清除的可以看上一讲)原来使用swagger,现在增加knife4j.

2.1 Ruoyi-cloud父级pom.xml 导入knife4j依赖包

  <dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-micro-spring-boot-starter</artifactId>
    <version>${knife4j.version}</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>${knife4j.version}</version>
</dependency>

2.2在ruoyi-common模块下新建ruoyi-common-knife4j

A ruoyi-common-knife4j 模块下pom.xml文件引入

   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
  </dependency>

  <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
  </dependency>

B ruoyi-common-knife4j 模块 新建三个文件如下

支持国产,开源微服务架构项目之Knife4j使用新建3个文件

C 需要生成接口文档模块,启动入口加入注解

 

@EnableCustomKnife4JSwagger2(源自ruoyi-common-knife4j),

原来注释 @EnableCustomSwagger2

D ruoyi-gateway 模块下pom文件 需要注释依赖如下

<dependency>     
  <groupId>io.springfox</groupId>     
 <artifactId>springfox-swagger-ui</artifactId>     
 <version>${swagger.fox.version}</version> 
</dependency> 

  <dependency>     
  <groupId>io.springfox</groupId>     
 <artifactId>springfox-swagger2</artifactId>     
 <version>${swagger.fox.version}</version> 
 </dependency>

下一讲 knifeJ4 安全方面的

欢迎关注转发留言。想获取学习资料关注微信公众号(IT小分享),回复 学习即可!