api管控平台（API管控）

本文目录一览：

• 1、API网关从入门到放弃

• 2、为什么要用wso2的api管理平台

• 3、有没有开源的api管理系统

• 4、还在发愁写API文档？推荐一款阿里腾讯都在用的API管理神器

API网关从入门到放弃

假设你正在开发一个电商网站，那么这里会涉及到很多后端的微服务，比如会员、商品、推荐服务等等。

那么这里就会遇到一个问题，APP/Browser怎么去访问这些后端的服务? 如果业务比较简单的话，可以给每个业务都分配一个独立的域名()，但这种方式会有几个问题:

更好的方式是采用API网关，实现一个API网关接管所有的入口流量，类似Nginx的作用，将所有用户的请求转发给后端的服务器，但网关做的不仅仅只是简单的转发，也会针对流量做一些扩展，比如鉴权、限流、权限、熔断、协议转换、错误码统一、缓存、日志、监控、告警等，这样将通用的逻辑抽出来，由网关统一去做，业务方也能够更专注于业务逻辑，提升迭代的效率。

通过引入API网关，客户端只需要与API网关交互，而不用与各个业务方的接口分别通讯，但多引入一个组件就多引入了一个潜在的故障点，因此要实现一个高性能、稳定的网关，也会涉及到很多点。

API 注册

业务方如何接入网关?一般来说有几种方式。

协议转换

内部的API可能是由很多种不同的协议实现的，比如HTTP、Dubbo、GRPC等，但对于用户来说其中很多都不是很友好，或者根本没法对外暴露，比如Dubbo服务，因此需要在网关层做一次协议转换，将用户的HTTP协议请求，在网关层转换成底层对应的协议，比如HTTP - Dubbo, 但这里需要注意很多问题，比如参数类型，如果类型搞错了，导致转换出问题，而日志又不够详细的话，问题会很难定位。

服务发现

网关作为流量的入口，负责请求的转发，但首先需要知道转发给谁，如何寻址，这里有几种方式:

服务调用

网关由于对接很多种不同的协议，因此可能需要实现很多种调用方式，比如HTTP、Dubbo等，基于性能原因，最好都采用异步的方式，而Http、Dubbo都是支持异步的，比如apache就提供了基于NIO实现的异步HTTP客户端。

因为网关会涉及到很多异步调用，比如拦截器、HTTP客户端、dubbo、redis等，因此需要考虑下异步调用的方式，如果基于回调或者future的话，代码嵌套会很深，可读性很差，可以参考zuul和spring cloud gateway的方案，基于响应式进行改造。

优雅下线

性能

网关作为所有流量的入口，性能是重中之重，早期大部分网关都是基于同步阻塞模型构建的，比如Zuul 1.x。但这种同步的模型我们都知道，每个请求/连接都会占用一个线程，而线程在JVM中是一个很重的资源，比如Tomcat默认就是200个线程，如果网关隔离没有做好的话，当发生网络延迟、FullGC、第三方服务慢等情况造成上游服务延迟时，线程池很容易会被打满，造成新的请求被拒绝，但这个时候其实线程都阻塞在IO上，系统的资源被没有得到充分的利用。另外一点，容易受网络、磁盘IO等延迟影响。需要谨慎设置超时时间，如果设置不当，且服务隔离做的不是很完善的话，网关很容易被一个慢接口拖垮。

而异步化的方式则完全不同，通常情况下一个CPU核启动一个线程即可处理所有的请求、响应。一个请求的生命周期不再固定于一个线程，而是会分成不同的阶段交由不同的线程池处理，系统的资源能够得到更充分的利用。而且因为线程不再被某一个连接独占，一个连接所占用的系统资源也会低得多，只是一个文件描述符加上几个监听器等，而在阻塞模型中，每条连接都会独占一个线程，而线程是一个非常重的资源。对于上游服务的延迟情况，也能够得到很大的缓解，因为在阻塞模型中，慢请求会独占一个线程资源，而异步化之后，因为单条连接所占用的资源变的非常低，系统可以同时处理大量的请求。

如果是JVM平台，Zuul 2、Spring Cloud gateway等都是不错的异步网关选型，另外也可以基于Netty、Spring Boot2.x的webflux、vert.x或者servlet3.1的异步支持进行自研。

缓存

对于一些幂等的get请求，可以在网关层面根据业务方指定的缓存头做一层缓存，存储到Redis等二级缓存中，这样一些重复的请求，可以在网关层直接处理，而不用打到业务线，降低业务方的压力，另外如果业务方节点挂掉，网关也能够返回自身的缓存。

限流

限流对于每个业务组件来说，可以说都是一个必须的组件，如果限流做不好的话，当请求量突增时，很容易导致业务方的服务挂掉，比如双11、双12等大促时，接口的请求量是平时的数倍，如果没有评估好容量，又没有做限流的话，很容易服务整个不可用，因此需要根据业务方接口的处理能力，做好限流策略，相信大家都见过淘宝、百度抢红包时的降级页面。

因此一定要在接入层做好限流策略，对于非核心接口可以直接将降级掉，保障核心服务的可用性，对于核心接口，需要根据压测时得到的接口容量，制定对应的限流策略。限流又分为几种:

稳定性

稳定性是网关非常重要的一环，监控、告警需要做的很完善才可以，比如接口调用量、响应时间、异常、错误码、成功率等相关的监控告警，还有线程池相关的一些，比如活跃线程数、队列积压等，还有些系统层面的，比如CPU、内存、FullGC这些基本的。

网关是所有服务的入口，对于网关的稳定性的要求相对于其他服务会更高，最好能够一直稳定的运行，尽量少重启，但当新增功能、或者加日志排查问题时，不可避免的需要重新发布，因此可以参考zuul的方式，将所有的核心功能都基于不同的拦截器实现，拦截器的代码采用Groovy编写，存储到数据库中，支持动态加载、编译、运行，这样在出了问题的时候能够第一时间定位并解决，并且如果网关需要开发新功能，只需要增加新的拦截器，并动态添加到网关即可，不需要重新发布。

熔断降级

熔断机制也是非常重要的一项。若某一个服务挂掉、接口响应严重超时等发生，则可能整个网关都被一个接口拖垮，因此需要增加熔断降级，当发生特定异常的时候，对接口降级由网关直接返回，可以基于Hystrix或者Resilience4j实现。

日志

由于所有的请求都是由网关处理的，因此日志也需要相对比较完善，比如接口的耗时、请求方式、请求IP、请求参数、响应参数(注意脱敏)等，另外由于可能涉及到很多微服务，因此需要提供一个统一的traceId方便关联所有的日志，可以将这个traceId置于响应头中，方便排查问题。

隔离

比如线程池、http连接池、redis等应用层面的隔离，另外也可以根据业务场景，将核心业务部署带单独的网关集群，与其他非核心业务隔离开。

网关管控平台

这块也是非常重要的一环，需要考虑好整个流程的用户体验，比如接入到网关的这个流程，能不能尽量简化、智能，比如如果是dubbo接口，我们可以通过到git仓库中获取源码、解析对应的类、方法，从而实现自动填充，尽量帮用户减少操作；另外接口一般是从测试-预发-线上，如果每次都要填写一遍表单会非常麻烦，我们能不能自动把这个事情做掉，另外如果网关部署到了多个可用区、甚至不同的国家，那这个时候，我们还需要接口数据同步功能，不然用户需要到每个后台都操作一遍，非常麻烦。

这块个人的建议是直接参考阿里云、aws等提供的网关服务即可，功能非常全面。

其他

其他还有些需要考虑到的点，比如接口mock，文档生成、sdk代码生成、错误码统一、服务治理相关的等，这里就不累述了。

目前的网关还是中心化的架构，所有的请求都需要走一次网关，因此当大促或者流量突增时，网关可能会成为性能的瓶颈，而且当网关接入的大量接口的时候，做好流量评估也不是一项容易的工作，每次大促前都需要跟业务方一起针对接口做压测，评估出大致的容量，并对网关进行扩容，而且网关是所有流量的入口，所有的请求都是由网关处理，要想准确的评估出容量很复杂。可以参考目前比较流行的ServiceMesh，采用去中心化的方案，将网关的逻辑下沉到sidecar中，

sidecar和应用部署到同一个节点，并接管应用流入、流出的流量，这样大促时，只需要对相关的业务压测，并针对性扩容即可，另外升级也会更平滑，中心化的网关，即使灰度发布，但是理论上所有业务方的流量都会流入到新版本的网关，如果出了问题，会影响到所有的业务，但这种去中心化的方式，可以先针对非核心业务升级，观察一段时间没问题后，再全量推上线。另外ServiceMesh的方案，对于多语言支持也更友好。

为什么要用wso2的api管理平台

对于API作者和发布者来说，该API管理器可以：

面向外部消费者、合作伙伴以及内部用户发布API，支持SOAP和REST服务

管理API版本（可以并行部署多个版本）

管理API的生命周期（发布、否决、撤销）

为API附上文档（文件、外部URL）

为API应用安全政策（认证、授权）

附加SLA（Service-Level Agreement，服务等级协议）

跟踪消费者的每个API

监视API的使用、性能和SLA依从性

有没有开源的api管理系统

、Dubbo整体架构

1、Dubbo与Spring整合

Dubbo使用做非简单管ProviderConsumer都通Spring配置文件进行配置配置完像使用

spring bean进行服务暴露调用完全看dubbo

api存dubbo使用spring提供扩展Schema自定义配置支持spring配置文件像、进行配置

META-INFspring.handlers文件指定dubboxml解析类：DubboNamespaceHandler像前面解

析ServiceConfig解析ReferenceConfig等等

2、jdk spi扩展

由于Dubbo源框架必须要提供扩展点Dubbo通扩展jdk

spi机制实现扩展具体说META-INF目录放置文件名接口全称文件key、value键值value具体实现类

全类名key标志值由于dubbo使用url总线设计即参数通URL象传递实际具体要用哪值通url参

数值指定

Dubbospi扩展通ExtensionLoader实现查看ExtensionLoader源码看Dubbojdk spi做三面扩展：

（1）jdk spi仅仅通接口类名获取所实现ExtensionLoader则通接口类名key值获取实现；

（2）Adaptive实现代理类根据实际调用些参数态决定要调用类

（3）自包装实现种实现类般自激用于包装类比Protocol两实现类：ProtocolFilterWrapper、ProtocolListenerWrapper

3、url总线设计

Dubbo使各层解耦采用url总线设计我通设计层与层间交互参数做Model层与层间沟通本比较扩展起

比较麻烦Dubbo各层间通信都采用url形式比注册启参数url：

registry://0.0.0.0:9090?codec=registrytransporter=netty

表示前注册绑定所ip端口9090解析器类型registry使用底层网络通信框架netty

二、Dubbo启程

Dubbo注册、服务提供者(provider)、服务消费者(consumer)三部

1、注册启程

注册启程主要看两类：RegistrySynchronizer、RegistryReceiver两类初始化都start

RegistrySynchronizerstart：

（1）所配置信息load内存；

（2）前注册信息保存数据库；

（3）启5定器

5定器功能：

（1）AutoRedirectTask自重定向定器默认1运行1前注册连接数高于平均值1.2倍则连接数重定向其注册达注册集群连接数均衡

（2）DirtyCheckTask脏数据检查定器作用：别检查缓存provider、数据库provider、缓存consumer、数据库

consumer数据清除脏数据；清理存providerconsumer数据；于缓存存provider或consumer数

据库存重新注册订阅

（3）ChangedClearTaskchanges变更表定清理任务作用读取changes表清除期数据

（4）AlivedCheckTask注册存状态定检查定更新registries表expire字段用判断注册存状态新注册发送同步消息前所注册址通知所客户端

（5）ChangedCheckTask变更检查定器检查changes表变更检查类型包括：参数覆盖变更、路由变更、服务消费者变更、权重变更、负载均衡变更

RegistryReceiverstart：启注册服务默认使用netty框架绑定本机9090端口启服务程NettyServer完接收消息抛dubbo协议解码器调用类顺序

NettyHandler-》NettyServer-》MultiMessageHandler-》HeartbeatHandler-》AllDispatcher-》

DecodeHandler-》HeaderExchangeHandler-》RegistryReceiver-》RegistryValidator-》RegistryFailover-》RegistryExecutor

2、provider启程

provider启程ServiceConfigexport始进行具体步骤：

（1）进行本jvm暴露放任何端口提供injvm种形式调用种调用本调用涉及进程间通信

（2）调用RegistryProtocolexport

（3）调用DubboProtocolexport默认启20880端口用提供接收consumer远程调用服务

（4）通新建RemoteRegistry建立与注册连接

（5）服务址注册注册

（6）注册订阅自服务

3、consumer启程

consumer启程通ReferenceConfigget进行具体步骤：

（1）通新建RemoteRegistry建立与注册连接

（2）新建RegistryDirectory并向注册订阅服务RegistryDirectory用维护注册获取服务相关信息

（3）创建代理类发起consumer远程调用实际调用InvokerInvocationHandler

三、实际调用程

consumer端发起调用实际调用经类：

1、consumer:

InvokerInvocationHandler-》MockClusterInvoker(配置Mock则直接调用本Mock类)-》FailoverClusterInvoker(负载均衡容错机制默认发错误情况进行两重试)-》RegistryDirectory$InvokerDelegete-》ConsumerContextFilter-》FutureFilter-DubboInvoker

NettyServer-》MultiMessageHandler-》HeartbeatHandler-》AllDispatcher-》DecodeHandler-》HeaderExchangeHandler-》DubboProtocol.requestHandler-》EchoFilter-》ClassLoaderFilter-》GenericFilter-》ContextFilter-》ExceptionFilter-》TimeoutFilter-》MonitorFilter-》TraceFilter-》实际service

四、Dubbo使用设计模式

1、工厂模式

ServiceConfig字段代码：

private static final Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();

Dubbo种代码种工厂模式实现类获取采用jdk

spi机制实现优点扩展性强想要扩展实现需要classpath增加文件代码零侵入另外像面

Adaptive实现做调用态决定调用哪实现由于种实现采用态代理造代码调试比较麻烦需要析实际调用实现类

2、装饰器模式

Dubbo启调用阶段都量使用装饰器模式Provider提供调用链例具体调用链代码

ProtocolFilterWrapperbuildInvokerChain完具体注解含group=provider

Filter实现按照order排序调用顺序

EchoFilter-》ClassLoaderFilter-》GenericFilter-》ContextFilter-》ExceptionFilter-》

TimeoutFilter-》MonitorFilter-》TraceFilter

更确切说装饰器责任链模式混合使用例EchoFilter作用判断否声测试请求直接返内容种责任链体

现像ClassLoaderFilter则主功能添加功能更改前线程ClassLoader典型装饰器模式

3、观察者模式

Dubboprovider启需要与注册交互先注册自服务再订阅自服务订阅采用观察者模式启listener

注册每5秒定检查否服务更新更新向该服务提供者发送notify消息provider接受notify消息即运行

NotifyListenernotify执行监听器

4、态代理模式

Dubbo扩展jdk

spi类ExtensionLoaderAdaptive实现典型态代理实现Dubbo需要灵控制实现类即调用阶段态根据参数决

定调用哪实现类所采用先代理类能够做灵调用代理类代码ExtensionLoader

createAdaptiveExtensionClassCode代理类主要逻辑获取URL参数指定参数值作获取实现类key

还在发愁写API文档？推荐一款阿里腾讯都在用的API管理神器

作为一个前后端分离模式开发的团队，我们经常会看到这样的场景：前端开发和后端开发在一起热烈的讨论“你这接口参数怎么又变了？”，“接口怎么又不通了？”，“稍等，我调试下”，“你再试试..."。

那能不能写好接口文档，大家都按文档来开发？很难，因为写文档、维护文档比较麻烦，而且费时，还会经常出现 API 更新了，但文档还是旧的，各种同步不一致的情况，从而耽搁彼此的时间。

之前我们团队也遇到了同样的问题，那么作为研发团队的负责人，我是如何带领团队解决这个问题的呢？

方法其实很简单，如果能做到让写文档/维护文档这件事情的短期收益就能远高于付出的成本，那么所有问题都能迎刃而解，开发人员就会非常乐意去写接口文档。

要做到写文档和及时维护文档的短期收益就能远高于付出的成本，无非两个方向：

鉴于此，我们设想如果有一款工具做到以下这些是不是就非常爽了？

总结下来，我们需要的就是这么一款工具：

为此，我们几乎尝遍了市面上所有相关的工具，但是很遗憾，没有找到合适的。

于是，我们自己实现了一个Postman + Swagger + RAP + JMeter

这个工具就是 Apifox，经常很长一段时间不断更新迭代后，我们基本上完全实现了最初的设想，几乎完美解决了最开始遇到的所有问题，在公司内部大受欢迎。并且也形成了我们自己的最佳实践。

没错，现在我们已经将Apifox产品化对外服务了，你们团队也可以直接使用Apifox了。

官网：

Apifox = Postman + Swagger + Mock + JMeter

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台。

通过一套系统、一份数据，解决多个系统之间的数据同步问题。只要定义好接口文档，接口调试、数据 Mock、接口测试就可以直接使用，无需再次定义；接口文档和接口开发调试使用同一个工具，接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确！

节省研发团队的每一分钟！

如果你认为 Apifox 只做了数据打通，来提升研发团队的效率，那就错了。Apifox 还做了非常多的创新，来提升开发人员的效率。

通常一个接口会有多种情况用例，比如 正确用例 参数错误用例 数据为空用例 不同数据状态用例。定义接口的时候定义好这些不同状态的用例，接口调试的时候直接运行，非常高效。

可以独立定义数据模型，接口定义时可以直接引用数据模型，数据模型之间也可以相互引用。同样的数据结构，只需要定义一次即可多处使用；修改的时候只需要修改一处，多处实时更新，避免不一致。

使用 Apifox 调试接口的时候，系统会根据接口文档里的定义，自动校验返回的数据结构是否正确，无需通过肉眼识别，也无需手动写断言脚本检测，非常高效！

Apifox 自动校验数据结构

设置断言：

Apifox 设置断言

运行后，查看断言结果：

先放一张图对比下 Apifox 和其他同类工具 零配置 mock 出来的数据效果：

Apifox Mock 数据结果对比同类工具

可以看出 Apifox 零配置 Mock 出来的数据和真实情况是非常接近的，前端开发可以直接使用，而无需再手动写 mock 规则。

「Apifox 如何做到高效率、零配置生成非常人性化的 mock 数据」

Apifox 项目可“在线分享” API 文档，分享出去的 API 文档可设置为公开或需要密码访问，非常方便与外部团队协作。

体验地址：

根据接口模型定义，自动生成各种语言/框架（如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等）的业务代码（如 Model、Controller、单元测试代码等）和接口请求代码。目前 Apifox 支持 130 种语言及框架的代码自动生成。

更重要的是：你可以通过自定义代码模板来生成符合自己团队的架构规范的代码，满足各种个性化的需求。

接口调试

Apifox 多种主题色可选

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。