APINTO

🚀快速入门教程

使用步骤

1、创建服务

2、绑定路由

流程示意图如下：

详细步骤说明

Apinto支持以下方式进行网关配置：

  • openAPI：可在网关使用过程中动态配置网关信息，包括路由、服务、负载均衡、鉴权、服务发现等

程序配置说明

文件名：apinto.yml 存放路径：/etc/apinto/ 作用：apinto运行配置文件，配置日志输出目录等相关信息

示例配置：

# 数据文件放置目录
data_dir: /var/lib/apinto

# pid文件放置地址
pid_dir: /var/run/apinto/

# 日志放置目录
log_dir: /var/log/apinto

# socket放置目录
socket_dir: /tmp/apinto

# apinto运行配置地址
config: config.yml

# 扩展仓库目录
extends_dir: /var/lib/apinto/extenders/

# 错误日志文件名
error_log_name:  error.log

# 错误日志等级
error_log_level: error

# 错误日志过期时间，默认单位为天，d|天，h|小时
error_log_expire: 7d

# 错误日志切割周期，仅支持day、hour
error_log_period: day

文件名：config.yml 存放路径：/etc/apinto/ 作用：指定节点的路由监听端口，ssl证书等信息

程序启动前需要配置与程序相同目录下的文件config.yml,用于指定节点的路由监听端口，ssl证书等信息。

version: 2
#certificate: # 证书存放根目录
#  dir: /etc/apinto/cert
client:
  #advertise_urls: # open api 服务的广播地址
  #- http://127.0.0.1:9400
  listen_urls: # open api 服务的监听地址
    - http://0.0.0.0:9400
  #certificate:  # 证书配置，允许使用ip的自签证书
  #  - cert: server.pem
  #    key: server.key
gateway:
  #advertise_urls: # 转发服务的广播地址
  #- http://127.0.0.1:9400
  listen_urls: # 转发服务的监听地址
    - https://0.0.0.0:8099
    - http://0.0.0.0:8099
peer: # 集群间节点通信配置信息
  listen_urls: # 节点监听地址
    - http://0.0.0.0:9401
  #advertise_urls: # 节点通信广播地址
  # - http://127.0.0.1:9400
  #certificate:  # 证书配置，允许使用ip的自签证书
  #  - cert: server.pem
  #    key: server.key

启动程序

  1. 安装网关：
./install.sh install

执行该步骤将会生成配置文件/etc/apinto/apinto.yml和/etc/apinto/config.yml，可根据需要修改。

  1. 启动网关
apinto start

使用openAPI配置网关

在程序启动后，我们可以通过openAPI动态配置网关信息

创建服务

以访问apinto官方示例接口为例, 将返回请求的相关信息。

curl -X POST http://127.0.0.1:9400/api/service \
-H "Content-type: application/json" \
-d '{
    "name": "apintoapi",
    "driver": "http",
    "description": "访问官方示例接口",
    "timeout": 3000,
    "retry": 3,
    "scheme": "http",
    "nodes": ["demo.apinto.com:8280"],
    "balance": "round-robin"
}'

服务配置参数说明点此进行跳转

创建路由，并且服务id绑定路由

将第1步返回的 id 值填入到路由配置的 target 中，如上例中的 id 为 apintoapi@service

curl -X POST http://127.0.0.1:9400/api/router \
-H "Content-type: application/json" \
-d '{
    "name": "apintoapi",
    "driver": "http",
    "description": "路由示例",
    "listen": 8099,
    "method": ["GET","POST"],
    "location": "/demo",
    "rules": [],
    "service": "apintoapi@service"
}'

注意：路由配置的listen必须在config.yml中的路由监听端口列表中存在。

路由配置参数说明点此进行跳转

至此，带有路由的服务转发配置完成

访问服务

curl 'http://127.0.0.1:8099/demo'

返回结果

{
    "body":"",
    "header":{
        "Accept":[
            "*/*"
        ],
        "User-Agent":[
            "curl/7.75.0"
        ],
        "X-Forwarded-For":[
            "127.0.0.1,127.0.0.1"
        ]
    },
    "host":"127.0.0.1:8099",
    "method":"GET",
    "path":"/demo",
    "query":{

    },
    "url":"/demo"
}