玩转API对象 - 玩转Kong网关

注意:API实体在0.13.0中被弃用。
强烈建议将您的api迁移到路由和服务。

API对象描述了一个由Kong公开的API。当使用者从代理端口调用它时,Kong需要知道如何检索API。每个API对象必须指定主机、uri和方法的一些组合。Kong将把所有对API的请求委托给指定的upstream URL。

1、添加API

请求地址:/apis/
请求方法:POST
请求主体:

属性 描述
name API的名称.
hosts(半可选) 指向您的API的逗号分隔的域名列表。例如:example.com。至少应该指定主机、uri或方法中的一个。
uris(半可选) 一个逗号分隔的uri前缀列表,指向您的API。例如: /my-path。至少应该指定主机、uri或方法中的一个。
methods(半可选) 一个以逗号分隔的HTTP方法列表,指向您的API。例如: GET,POST。至少应该指定主机、uri或方法中的一个。
upstream_url 指向您的API服务器的基本目标URL。这个URL将用于代理请求。例如: https://example.com.
strip_uri(可选) 当通过一个URI前缀匹配一个API时,要从upstream URI中去掉匹配的前缀。默认值:真的。
preserve_host(可选) 当通过一个主机域名匹配一个API时,请确保请求主机头被转发到upstream服务。默认false,upstream主机头将从配置的upstream_url中提取出来。
retries(可选) 在代理失败的情况下执行的重试次数。默认值是5。
upstream_connect_timeout(可选) 建立连接到upstream服务的连接的超时时间。默认为60000。
upstream_send_timeout(可选) 在两个连续的写操作之间的时间间隔内,将请求发送到upstream服务的默认值为60000。
upstream_read_timeout(可选) 在两个连续读取操作之间的毫秒间隔,将请求发送到upstream服务的默认值为60000。
https_only(可选) 如果您希望仅通过HTTPS在适当的端口上提供API(默认情况下是8443),那么就可以启用该API。默认值:false。
http_if_terminated(可选) 在执行HTTPS通信时,考虑一下X-Forwarded-Proto header. 默认: false

注:通用但非标准的HTTP头(通常,非标准的头域都是用“X-”开头)

X-Forwarded-Proto:记录一个请求一个请求最初从浏览器发出时候,是使用什么协议。因为有可能当一个请求最初和反向代理通信时,是使用https,但反向代理和服务器通信时改变成http协议,这个时候,X-Forwarded-Proto的值应该是https

2、检索API

请求地址:/apis/{name or id}
请求方法:GET
PATH参数:

属性 描述
name or id(必填) 要检索的API的唯一标识符或名称。

3、API列表

请求地址:/apis/
请求方法:GET
请求参数:

属性 描述
id(可选) 基于api id字段的过滤器。
name(可选) 基于api name字段的过滤器。
upstream_url(可选) 基于api upstream_url字段的过滤器。
retries(可选) 基于api retries字段的过滤器。
offset(可选) 用于分页的游标。偏移量是定义列表中的位置的对象标识符。
size(可选,默认是100) 每个页面返回的对象数量的限制。

4、更新API

请求地址:/apis/{name or id}
请求方法:GET
PATH参数:

属性 描述
name or id(必填) 要更新的API的唯一标识符或名称。

请求主体:与 1、添加API 请求主体相同

5、更新或创建API

请求地址:/apis/
请求方法:PUT
请求主体:与 1、添加API 请求主体相同

PUT接口的行为如下:如果请求的payload(AJAX请求)不包含实体的主键(APIs的id),则该实体将使用给定payload创建。如果请求的payload确实包含一个实体的主键,有效负载将“替换”给定主键指定的实体。如果主键不是现有实体的,则不会返回404。

6、删除API

请求地址:/apis/{name or id}
请求方法:DELETE
PATH参数:

属性 描述
name or id(必填) 唯一的标识符或要删除的API的名称。

穿梭机:开源API网关系统(Kong教程)入门到精通

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,706评论 4 366
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,002评论 1 301
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,462评论 0 250
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,375评论 0 216
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,763评论 3 294
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,849评论 1 224
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,033评论 2 317
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,768评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,490评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,734评论 2 253
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,204评论 1 264
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,566评论 3 260
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,227评论 3 241
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,137评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,934评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,926评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,774评论 2 274