Skip to content

README.md

Latest commit

 

History

History
280 lines (231 loc) · 6.12 KB

README.md

File metadata and controls

280 lines (231 loc) · 6.12 KB

HengHa

Build Status Commitizen friendly codecov

一个基于node.js的API Gateway

目录

安装

git clone https://github.com/hashmaparraylist/HengHa.git
cd ./HengHa
npm install

启动

node index.js -c config.json

参数

-c filename 指定配置文件，如不指定则使用默认配置文件

访问入口

  • API默认入口 http://hostname:1981/
  • ADMIN默认入口 http://hostname:2016/

配置

在不指定配置文件的情况下，使用下述默认配置文件

  // 数据文件存放位值
  "data": {
    "file": "./data/hengha.json"
  },

  // Gateway端配置
  "gateway": {
    "port": 1981,
    "logger": {
      "level": "debug" 
    }
  },

  // 管理端配置
  "admin": {
    "port": 2016,
    "authorization": {      
      "user": "admin",
      "password": "admin"
    },
    "logger": {
      "level": "debug"
    }
  }

管理端API

GET /api

获取所有登录的API

# Request
GET /api HTTP/1.1
Host: localhost:2016
User-Agent: curl/7.43.0
Accept: */*
Authorization:Basic YWRtaW46YWRtaW4=

# Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 469
Date: Fri, 02 Sep 2016 08:02:41 GMT
Connection: keep-alive

# Response Body
[  
   {  
      "location":"/demo1/",
      "proxy_pass":"http://localhost:7777/service/demo1-service/",
      "id":"9b0f6740-69d4-11e6-a2ca-976ed89ed127"
   },
   {  
      "location":"/demo2/",
      "proxy_pass":"http://localhost:7777/api/demo2-service/",
      "id":"a66e0470-69d4-11e6-a2ca-976ed89ed127"
   }
]

GET /api/:id

获取指定id的api

# Request
GET /api/9b0f6740-69d4-11e6-a2ca-976ed89ed127 HTTP/1.1
Host: localhost:2016
User-Agent: curl/7.43.0
Accept: */*
Authorization:Basic YWRtaW46YWRtaW4=

# Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 123
Date: Fri, 02 Sep 2016 08:14:37 GMT
Connection: keep-alive

# Response Body
{  
    "location":"/demo1/",
    "proxy_pass":"http://localhost:7777/service/demo1-service/",
    "id":"9b0f6740-69d4-11e6-a2ca-976ed89ed127"
}

POST /api

追加一个新的api

# 使用示例
curl -v \
     -H Authorization:'Basic YWRtaW46YWRtaW4=' \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{"locastion": "/dem9/", "proxy_pass": "http://localhost:7777/service/demo9/"}' \
     http://localhost:2016/api 
# Request
POST /api HTTP/1.1
Host: localhost:2016
User-Agent: curl/7.43.0
Accept: */*
Authorization:Basic YWRtaW46YWRtaW4=
Content-Type: application/json
Content-Length: 77

# Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 118
Date: Fri, 02 Sep 2016 08:30:35 GMT
Connection: keep-alive

# Response Body
{  
   "locastion":"/dem9/",
   "proxy_pass":"http://localhost:7777/service/demo9/",
   "id":"85581f40-70e7-11e6-85e3-674d3ab2db19"
}

PUT /api/:id

更新一个已有的api

# 使用示例
curl -v \
     -H Authorization:'Basic YWRtaW46YWRtaW4=' \
     -H "Content-Type: application/json" \
     -X PUT \
     -d '{"locastion": "/dem9/", "proxy_pass": "http://localhost:7777/api/demo9/"}' \
     http://localhost:2016/api/85581f40-70e7-11e6-85e3-674d3ab2db19
# Request
PUT /api/85581f40-70e7-11e6-85e3-674d3ab2db19 HTTP/1.1
Host: localhost:2016
User-Agent: curl/7.43.0
Accept: */*
Authorization:Basic YWRtaW46YWRtaW4=
Content-Type: application/json
Content-Length: 73

# Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 650
Date: Fri, 02 Sep 2016 08:48:39 GMT
Connection: keep-alive

# Response Body
[  
   {  
      "location":"/demo1/",
      "proxy_pass":"http://localhost:7777/service/demo1-service/",
      "id":"9b0f6740-69d4-11e6-a2ca-976ed89ed127"
   },
   {  
      "location":"/demo2/",
      "proxy_pass":"http://localhost:7777/api/demo2-service/",
      "id":"a66e0470-69d4-11e6-a2ca-976ed89ed127"
   },
      {  
      "locastion":"/dem9/",
      "proxy_pass":"http://localhost:7777/api/demo9/",
      "id":"85581f40-70e7-11e6-85e3-674d3ab2db19"
   }
]

DELETE /api:id

删除一个已有的api

# 使用示例
curl -v \
     -H Authorization:'Basic YWRtaW46YWRtaW4=' \
     -X DELETE \
     http://localhost:2016/api/85581f40-70e7-11e6-85e3-674d3ab2db19
# Request
DELETE /api/85581f40-70e7-11e6-85e3-674d3ab2db19 HTTP/1.1
Host: localhost:2016
User-Agent: curl/7.43.0
Accept: */*
Authorization:Basic YWRtaW46YWRtaW4=

# Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 535
Date: Fri, 02 Sep 2016 09:00:19 GMT
Connection: keep-alive

# Response Body
[  
   {  
      "location":"/demo1/",
      "proxy_pass":"http://localhost:7777/service/demo1-service/",
      "id":"9b0f6740-69d4-11e6-a2ca-976ed89ed127"
   },
   {  
      "location":"/demo2/",
      "proxy_pass":"http://localhost:7777/api/demo2-service/",
      "id":"a66e0470-69d4-11e6-a2ca-976ed89ed127"
   }
]

URL匹配

URL匹配基本遵循Nginx的匹配规则

匹配命令

  • ~ 波浪线表示执行一个正则匹配，区分大小写
  • ~* 表示执行一个正则匹配，不区分大小写
  • ^~ ^~表示普通字符匹配，如果该选项匹配，只匹配该选项，不匹配别的选项，一般用来匹配目录
  • = 进行普通字符精确匹配

匹配的优先级

  1. =前缀的指令严格匹配这个查询。如果找到，停止搜索。
  2. 所有剩下的常规字符串，最长的匹配。如果这个匹配使用^〜前缀，搜索停止。
  3. 正则表达式，在配置文件中定义的顺序。
  4. 如果第3条规则产生匹配的话，结果被使用。否则，如同从第2条规则被使用。