Knife4jCloud 正式上线,云端聚合Swagger文档

0.目录

1.产品介绍

Knife4jCloud是一款独立部署的中间件,基于Spring Boot 2.2.0.RELEASE+Mybatis 3.5进行开发.

将目前开源的Knife4j进行整合,通过云平台对OpenAPI v2的Swagger文档进行云端聚合,在线对Swagger文档进行渲染和调试,非常灵活方便,特别是在微服务盛行的今天,对于使用Swagger的开发者来说,是一款非常轻巧、方便、简单、易用的产品.

产品的主要优势：

1).跨语言

使用Swagger的开发者都知道,OpenAPI是一套标准的规范,在不同的语言中都有相应的实现方式,包括Java、Node、Python、.Net等语言,使用范围非常广泛,特别是Java体系下Spring的生态非常完善,Springfox组件提供了对OpenAPI的支持,将SpringMVC接口和Swagger紧密的联系了起来,方便开发者进行接口的调试

也正是因为这种原因,Knife4j目前经历近3年的发展,OpenAPI2.0版本已经越来越成熟,Java的开发者集成Knife4j非常方便,但是其他语言目前想要使用Knife4j都会有一些难度,需要更改相关的代码才能做到集成,使用上很麻烦

Knife4jCloud平台作为独立的平台,不管是提供OpenAPI的接口还是提供Swagger的JSON,都可以通过在平台上简单操作,即可情况将OpenAPIV2的结构在Knife4j的Ui上展示出来.

2).微服务模式下自动聚合

在目前的Knife4j技术交流群中,经常会碰到各个开发者询问如何在Spring Cloud的微服务技术架构下聚合Swagger文档,有的人聚合成功了,有的人聚合失败了

究其原因,Spring Cloud技术架构发展相当迅速,部分开发人员无暇去通过调试底层代码的方式来解决碰到的问题,特别是Swagger文档的聚合一般都是通过网关的特性进行聚合,而微服务架构的网关从Zuul到Spring Cloud Gateway的迭代,都是发展惊人的,新版本的迭代必然会碰到版本兼容的问题,网关的迭代,每一次的迭代新增了那些特性,删除了那些特性,大部分情况下,我们是不会去看迭代日志的.升级就完事了.这也是为什么有人成功,有人失败

那么,通过现象看本质,我们碰到的问题到底是什么?

1、网关版本升级,导致请求Swagger接口失败,或者丢失某个属性

2、网关配置不正确,调试转发失败

3、等等…

我们在Spring Boot单体架构下,引入Swagger文档如此简单,为什么在Spring Cloud的体现这么麻烦?聚合代码写了一大堆,还要调试为何失败,不同的版本有不同的要求.等等

那么,Knife4jCloud是如何解决这些问题的呢?

1、Knife4jCloud把Swagger的特性全部抽象出来,全部放在平台里来做,他充当的也是一个网关的角色,但是是自己扩展实现的,扩展的目的只有一个,就是可以在平台中进行调试

2、Knife4jCloud中会把每一个Swagger文档作为一个服务实例，微服务的IP、端口、Swagger-JSONNeri都会保存在平台中

这样在平台中,对于Swagger文档可以进行任意聚合,和微服务彻底拜拜了~~

3).个性化配置

Knife4jCloud产品本身是拥有用户的角色的,开发者可以将平台部署在和实际同一个网络环境中,对外的Swagger文档可以通过Knife4jCloud做到网络隔离

对于每一份Swagger文档页可以做到是否登录后可看,文档是否可以调试等等个性化的配置都可以在平台中进行操作

2.功能介绍

Knife4jCloud V1.0版本目前提供的功能主要包括：

• 个人用户&登录&注册：通过邮箱的方式进行注册,数据完全隔离,每个人只能看到自己的数据
• 工作台：当前项目、服务的简单统计情况
• 项目管理：可以对项目进行编辑维护
• 服务管理：可以对服务列表进行编辑维护

2.1登录

Knife4jCloud通过个人邮箱的方式进行登录注册,所以在系统数据是完全隔离的,每个人只能看到自己的数据

注册界面：

2.2工作台

在项目主页工作台,会显示当前用户的项目数量、服务数量、服务分类情况

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1nKCGnUf-1591321765530)(workplan.png)]

2.3项目管理

项目管理包含了对当前项目的新增、编辑、删除、查询等功能

项目主要包含的字段：项目编号、项目名称、项目描述

项目编号是全局唯一,并且只能是数字或英文或者是英文+数字+下划线等方式组成

3.4服务管理

服务在Knife4jCloud中的定义其实是一个OpenAPIv2的实例,一个服务可以是通过API接口获取的,也可以是通过Swagger的JSON来创建,所以在服务管理中,存在两种类型：

• API:微服务在线的方式,获取得到当前的OPenAPIv2的实例,通过Knife4j的Ui进行接口渲染
• LOCAL:本地化的方式,使用者提供Swagger的JSON来创建服务实例

通过在线API的方式来创建服务实例：

通过本地LOCAL的方式创建

2.5预览文档

通过项目管理列表中的操作按钮,可以选择预览文档查看文档

3.开放API

Knife4jCloud平台对外提供注册Swagger服务的开放API接口,通过该接口,非Java语言的开发者,可以进行独立开发,做到Swagger文档的项目自启动注入平台

3.1注册API

接口地址：/knife4j/cloud/upload

接口类型：application/json

接口方式：POST

接口参数：

{
    "accessKey":"JDUkd1YvSi5zZmUkMHYuSGNmN1hMazJPajJuMjNJVW43dWNyL2tyR3N4bzJaa1A2ZC5mSUlwNA",
    "code":"APIFactory",
    "applicationHost":"192.168.0.152",
    "applicationPort":"9200",
    "ssl":false,
    "client":"",
    "cloudRoutes":[{
        "groupName":"订单服务",
        "content":"{....}",
        "path":"/aaa/v2/api-docs?group=订单服务"
    }]
}

参数说明：

• accessKey:该参数是注册API接口的认证凭证,每一个注册用户拥有自己独立的accessKey,平台注册成功后可以在个人信息中获取
• code:项目编码,如果在平台中不存在,则注册不会成功,因此需要先在平台中添加项目
• applicationHost:当前应用服务的IP地址,该参数主要作用于Swagger调试
• applicationPort：当前应用服务的端口号
• ssl:默认false,如果是true,则代表当前服务是https
• client:配置一个应用服务的Client地址,一般是http://host:port,Knife4j会自动识别,如果开发者提供的是域名访问,防火墙屏蔽了端口号(例如：http://doc.xiaominfo.com),则开发者在上传的时候需要设置该属性,否则无法调试,该参数设置后则Host、Port不会生效,会根据该地址自动解析得到host和端口,所以两个属性配置其中一个即可.
• cloudRoutes:服务分组
  • groupName:服务名称
  • content:该内容是OpenAPIv2的JSON结构
  • path:提供访问得到OpenAPIv2的接口地址,在实际预览的时候,会通过该接口得到Swagger的JSON内容进行渲染

3.2 Spring Boot自动注册

如果你的项目是通过Spring Boot进行开发,并且不想通过Knife4jCloud提供的界面进行操作,并且已经集成了springfox-swagger组件,那么,你可以引用Knife4jCloud提供的自动注册的jar包组件进行自动注册

1.Maven引用

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-discovery-spring-boot-starter</artifactId>
    <!--在引用时请在maven中央仓库(http://search.maven.org)搜索最新版本号-->
    <!-- 该版本必须和Knife4jCloud主版本一致-->
    <version>1.0</version>
</dependency>

2、在application.yml或者application.properties配置文件中配置相关参数,以yml为例：

knife4j:
  cloud:
    ## 参考注册API中的accessKey
    accessKey: JDUkd1YvSi5zZmUkMHYuSGNmN1hMazJPajJuMjNJVW43dWNyL2tyR3N4bzJaa1A2ZC5mSUlwNA
    ## 项目编号
    code: APITest
    ## Knife4jCloud的对外域名地址
    server: http://cloud.xiaominfo.com
    ## 当前服务是否是HTTPS的,默认可以不配置,并且该参数默认为false
    ssl: false
    ## 参考注册API中的client属性,该参数可以不配置,只有在域名的情况下需要进行配置
    client: http://test.domain.com
    

3、在Spring Boot应用中通过注解@EnableKnife4jCloudDiscovery进行启用

@EnableKnife4jCloudDiscovery
@SpringBootApplication
public class Knife4jSpringBootDemoApplication implements WebMvcConfigurer{
    //more..
}

4.产品试用

可以访问http://cloud.xiaominfo.com进行注册试用.