VX-API-Gateway開源網關技術的使用記錄

官網地址 https://mirren.gitee.io/vx-api-gateway-doc/

VX-API-Gateway(以下稱為VX-API)是基于Vert.x (java)開發(fā)的
API網關,
是一個分布式、全異步、高性能、可擴展、輕量級的可視化配置的API網關服務

官網下載程序zip包

訪問 https://gitee.com/mirren/VX-API-Gateway/releases

下載最新的程序zip包

安裝和使用

找個目錄解壓程序包

啟動程序bin目錄里的start.bat或start.sh

瀏覽器訪問5256端口

點擊進入首頁后，會進入
http://localhost:5256/static/Application.html
提示要登錄，默認賬號是VXAdmin，密碼是hivx

登錄密碼在安裝目錄的conf下的user.json中配置

登錄后可以新建應用

新建應用是指 你的vx-api-gateway網關要對接的服務名或應用名以及相關信息配置

創(chuàng)建應用

vx網關代理的http參數設置，都可以不填，會自動使用默認參數設置，（如需修改可以按需填寫）

應用創(chuàng)建好后，可以在應用列表中看到

創(chuàng)建應用下的API代理

點擊API管理，可以在剛剛建的應用上創(chuàng)建API

創(chuàng)建一個get請求代理

目標：訪問/sgate/t1 后自動代理到真實后端的/demo/t1

代理API的的返回結果配置不用特別修改，默認會自動返回后端真實API的數據

創(chuàng)建完成后，可以在api列表里看到
最后，要啟用剛剛建的應用和應用下的API代理

在應用詳情頁面點擊啟動應用

在API詳情頁面點擊啟動某個API代理

啟動完成后，點擊運行狀態(tài)頁面，可以觀察到當前vx-api-gateway的運行狀態(tài)

最后可以使用postman測試是否代理成功
訪問
http://127.0.0.1:8330/sgate/t1 后
自動代理到真實后端的
http://127.0.0.1:8085/demo/t1
返回后端真實服務接口的數據

實測發(fā)現可以代理成功，請求耗時188ms

在API詳情頁也可以看到相關的網關日志如下

VX-API-Gateway技術架構

應用Application

應用可以理解為分組,是VX-AP中的一個運行單元,一個應用相當于一個服務器(Server)不同的是他的端口號允許被重復使用,也就是說在VX-API中一個端口號可以給任意應用綁定(前提是這個端口號沒有被別的程序綁定),應用用于管理API
訪問http://localhost:端口號(默認5256)/static/Application.html或者通過http://localhost:端口號(默認5256)進入后便可以查看與管理應用

API接口

API是VX-API的服務核心,創(chuàng)建應用后便可以在應用的API管理中創(chuàng)建API;
當前版本中API支持三種服務類型,
HTTP/HTTPS服務(既VX-API需要去請到后臺服務器的類型):參數檢查與透傳,支持帶權重的負載均衡訪問策略,輪詢與IP哈希化,自動斷路與重試不可用的后臺服務地址
頁面跳轉服務:當用戶訪問時redirect到指定頁面
自定義服務:可以自定義任意服務,當前版本中實現了,基于session-token的認證授權,獲取服務器時間戳,與獲取常量
同時API支持全局黑名單,流量限制,權限認證,自定義前置/后置處理器等

API的執(zhí)行流程

綠線代表一定會執(zhí)行,黑線代表當存在時執(zhí)行,當用戶請求的時候,完整的流程按組件順序由1開始執(zhí)行到7,如果不滿足任意一個組件時請求結束并響應(fail-end-response),當任意組件出現異常時統一進入異常組件(Exception Handler)請求結束并響應錯誤信息
更多API的執(zhí)行流程介紹參考下方API組件介紹文章來源地址http://www.zghlxwxcb.cn/news/detail-627710.html

總結

VX-API-Gateway 是一個輕量的，支持可視化配置的網關代理服務。
可以代理多個后端應用，同時可以對每個后端應用的API做精細化的API代理配置。
由于VX-API-Gateway 底層使用的是vert.x技術，所以不必擔心性能問題

到了這里，關于VX-API-Gateway開源網關技術的使用記錄的文章就介紹完了。如果您還想了解更多內容，請在右上角搜索TOY模板網以前的文章或繼續(xù)瀏覽下面的相關文章，希望大家以后多多支持TOY模板網！