bitea / api-mirror

一个可以并发访问后端API接口，并返回响应最快的哪一个

api-mirror

一个十分简单的转发工具

指定一个URL后，可以同时对多个API地址发起请求，返回最快的哪一个。

Features

• 支持自定义多组转发配置
• 支持指定多个并发域名，并为每个域名配置权重
• 支持为每组转发配置指定超时时间、限流器、并发域名数量和过滤header头

CONFIG

配置示例

# http服务启动端口
port: 8899

proxyConfig:
  - desc: "订阅转换服务"
    paths: # URL中PATH 不包含参数 。 可以配置多个
      - path: "/sub"   # URL中PATH 不包含参数 。 可以配置多个
        matchType: "exact"  # paths匹配模式, exact：精确匹配、prefix：前缀匹配、regexp：正则匹配
        remove: ""          # 去除字符串，在请求之前，将请求URL中PATH的path去掉改字符串
      - path: "/version"
        matchType: "exact"
      - path: "/readconf"
        matchType: "exact"
      - path: "/updateconf"
        matchType: "exact"
      - path: "/getruleset"
        matchType: "exact"
      - path: "/getprofile"
        matchType: "exact"
      - path: "/qx-script"
        matchType: "exact"
      - path: "/qx-rewrite"
        matchType: "exact"
      - path: "/render"
        matchType: "exact"
      - path: "/convert"
        matchType: "exact"
      - path: "/getlocal"
        matchType: "exact"
    hosts: # 要并发访问的host
      - host: "https://id9.cc"
        weight: 1
      - host: "https://sub.xeton.dev"
        weight: 1
      - host: "https://api.dler.io"
        weight: 1
      - host: "https://sub.maoxiongnet.com"
        weight: 1
    filter:
      timeOut: 5000     # 超时时间 单位毫秒
      limitQps: 20      # 限流器，每秒只允许limiterQps访问,超过就
      limitHosts: 3     # 如果hosts数量过多，则随机选limit个进行请求
      limitRespHeaders: # 要过滤掉的响应头header，大小写敏感
        - "Set-Cookie"

精简版

# http服务启动端口
port: 8899

proxyConfig:
  - desc: "订阅转换服务"
    paths: # URL中PATH 不包含参数 。 可以配置多个
      - path: "/"   # URL中PATH 不包含参数 。 可以配置多个
        matchType: "prefix"  # paths匹配模式, exact：精确匹配、prefix：前缀匹配、regexp：正则匹配
    hosts: # 要并发访问的host
      - host: "https://id9.cc"
        weight: 1
      - host: "https://sub.xeton.dev"
        weight: 1
      - host: "https://api.dler.io"
        weight: 1
      - host: "https://sub.maoxiongnet.com"
        weight: 1
    filter:
      timeOut: 5000     # 超时时间 单位毫秒
      limitQps: 20      # 限流器，每秒只允许limiterQps访问,超过就
      limitHosts: 3     # 如果hosts数量过多，则随机选limit个进行请求
      limitRespHeaders: # 要过滤掉的响应头header，大小写敏感
        - "Set-Cookie"

安装和启动

使用

1. 编辑配置文件config.yaml
2. 启动服务后。
3. 访问xxx:port/sub?xxxx网址
4. 后端就会把网址替换为多个域名地址，并发访问，并返回最快响应的

从源码编译

需要安装Golang

$ go get -u -v github.com/leosam2048/api-mirror

使用docker进行启动

注：需要自行安装git和docker环境

docker**仓库拉取

# 拉取git仓库
docker pull leosam2048/api-mirror:latest

本地构建docker镜像

# 拉取git仓库
git clone https://github.com/leosam2048/api-mirror.git

# 进入仓库
cd api-mirror

# 构建docker镜像
docker build ./ -t leosam2048/api-mirror:latest

本地构建docker镜像

# 运行docker镜像（前台运行）
docker run -p 8899:8899  leosam2048/api-mirror:latest

# 运行docker镜像（前台运行+映射本地自定义文件）
docker run -p 8899:8899 -v /opt/config/api-mirror.yaml:/config.yaml leosam2048/api-mirror:latest

# 运行docker镜像（前台运行+使用远程配置文件）
docker run -p 8899:8899 -e MIRROR_CONFIG_FILE="https://example.com/api.yaml,config.yaml" leosam2048/api-mirror:latest

# 运行docker镜像（后台运行）
docker run -dit --restart always -p 8898:8899 leosam2048/api-mirror:latest

# 运行docker镜像（后台运行+指定容器名称）
docker run -dit --name api-mirror --hostname api-mirror --restart always -p 8899:8899 leosam2048/api-mirror:latest

# 运行docker镜像（后台运行+指定容器名称+映射本地自定义文件）
docker run -dit --name api-mirror --hostname api-mirror --restart always -p 8899:8899 -v /opt/config/api-mirror.yaml:/config.yaml  leosam2048/api-mirror:latest

# 如果再次构建运行的时候，出现说container冲突的话,删除container对应的的ID就行
docker rm container对应的的ID

修改配置文件

启动项目前，请首先修改 config.yaml 中的必要配置信息。

程序指定配置文件优先级：从高到底

1. 使用运行参数 c指定
./api-mirror -c config.yaml

2. 通过环境变量 MIRROR_CONFIG_FILE 指定 ，添加环境变量或者docker
docker run -e MIRROR_CONFIG_FILE="config.yaml"

3. 兜底使用程序目录下的 config.yaml。无需指定

配置文件路径可以配置多个，使用逗号分隔，支持网络地址和磁盘地址。程序运行时，会依次取读，如果取读成功，则使用该配置文件

./api-mirror -c https://example.com/api.yaml,config.yaml,/opt/config.yaml

License

This software is released under the GPL-3.0 license.