Go API是基于服务发现驱动开发的可插拔API框架,旨在帮助构建强大的API网关。

概览

Go API支持网关路由。微服务架构是把应用解耦成逻辑上的相对隔离的服务,API网关提供单一的入口把服务的API统一起来。Go API使用服务发现中定义的元数据来生成路由规则并提供与之对应的http服务。

Go API

运行时工具micro api便是基于Go API构建。

Handler处理器

Handler专门用于接收并处理HTTP请求,为了方便,handler使用服务方法http.Handler的名字来路由。

micro api支持以下类型的网关转发

  • api - http转RPC请求
  • broker - pub/sub 异步请求
  • cloudevents - 专门处理CloudEvent事件,并向消息总线分发消息
  • event - 处理任意的http请求并向消息总线分发消息。
  • http - 处理http请求并转向反向代理。
  • registry - http 注册
  • rpc - 处理json及protobuf格式的POST请求,并转向RPC。
  • web - 包含web socket的http反向代理。

API Handler

API Handler是默认的处理器,负责把内部的RPC服务对外暴露成http接口,它接收并处理http请求,再转成RPC请求转向具体服务,最后返回RPC服务的响应结果。

  • Content-Type: 所有类型
  • Body: 任务类型
  • Forward Format: api.Request/api.Response
  • Path: /[service]/[method]
  • Resolver: 请求解析器,路径会被解析成服务与方法

Broker Handler

broker handler Pub/Sub 订阅分发处理器,将内部的Pub/Sub服务接口对外暴露成Http接口,接收http请求,并根据参数指向的主题发送消息。

  • Content-Type: Any
  • Body: Any
  • Forward Format: HTTP
  • Path: /
  • Resolver: 订阅主题通过query请求参数指定

CloudEvents Handler

云事件处理器提供HTTP入口,并把收到的请求转成CloudEvent消息通过消息总线的go-micro/client.Publish方法传出去。

  • Content-Type: Any
  • Body: Any
  • Forward Format: 请求会按照CloudEvents格式化
  • Path: /[topic]
  • Resolver: 请求路径会用来解析主题

Event Handler

事件处理器提供HTTP入口,把请求转成消息调用go-micro/client.Publish方法通过消息总线发送出去。

  • Content-Type: Any
  • Body: Any
  • Forward Format: 请求会按照go-api/proto.Event格式化
  • Path: /[topic]/[event](可以看到与CloudEvents的不同)
  • Resolver: 请求路径会用来解析主题及事件名

HTTP Handler

Http处理器是HTTP的反向代理,其内置有服务发现。

  • Content-Type: Any
  • Body: Any
  • Forward Format: 反向代理
  • Path: /[service]
  • Resolver: 请求路径会用来解析服务名

Registry Handler

注册处理器接收HTTP请求,它负责go-micro的注册接口请求

  • Content-Type: Any
  • Body: JSON
  • Forward Format: HTTP
  • Path: /
  • Resolver: 获取服务,注册与卸载服务分别通过GET, POST, DELETE请求处理。

RPC Handler

RPC处理器接收JSON或protobuf的HTTP请求,并转成RPC请求向前转发。

  • Content-Type: application/json or application/protobuf
  • Body: JSON 或者 Protobuf
  • Forward Format: json-rpc 或 proto-rpc,根据请求内容决定
  • Path: /[service]/[method]
  • Resolver: 请求路径会用来解析服务名与方法名

Web Handler

web处理器职责是反向代理,它内置服务发现,并支持web socket。

  • Content-Type: Any
  • Body: Any
  • Forward Format: 反向代理且支持web socket
  • Path: /[service]
  • Resolver: 请求路径会用来解析服务名