Преглед на файлове

doc(source): httppull source and rest sink new properties

Signed-off-by: Jiyong Huang <huangjy@emqx.io>
Jiyong Huang преди 2 години
родител
ревизия
65b1b35494

Файловите разлики са ограничени, защото са твърде много
+ 30 - 0
docs/en_US/guide/sinks/builtin/rest.md


Файловите разлики са ограничени, защото са твърде много
+ 50 - 1
docs/en_US/guide/sources/builtin/http_pull.md


Файловите разлики са ограничени, защото са твърде много
+ 30 - 0
docs/zh_CN/guide/sinks/builtin/rest.md


+ 49 - 0
docs/zh_CN/guide/sources/builtin/http_pull.md

@@ -26,6 +26,28 @@ default:
   # 请求所需的HTTP标头
   headers:
     Accept: application/json
+  # 如何检查响应状态,支持通过状态码或 body
+  responseType: code
+  # 获取 token
+#  oAuth:
+#    # 设置如何获取访问码
+#    access:
+#      # 获取访问码的 URL,总是使用 POST 方法发送请求
+#      url: https://127.0.0.1/api/token
+#      # 请求正文
+#      body: '{"username": "admin","password": "123456"}'
+#      # 令牌的过期时间,以字符串表示,时间单位为秒,允许使用模板
+#      expire: '3600'
+#    # 如何刷新令牌
+#    refresh:
+#      # 刷新令牌的 URL,总是使用 POST 方法发送请求
+#      url: https://127.0.0.1/api/refresh
+#      # HTTP 请求头,允许使用模板
+#      headers:
+#        identityId: '{{.data.identityId}}'
+#        token: '{{.data.token}}'
+#      # 请求正文
+#      body: ''
 
 #重载全局配置
 application_conf: #Conf_key
@@ -83,7 +105,34 @@ http 请求的超时时间,单位为 ms。
 
 需要与 HTTP 请求一起发送的 HTTP 请求标头。
 
+### 响应类型
 
+定义如何解析 HTTP 响应。目前支持两种方式:
+- code:通过 HTTP 响应码判断响应状态。
+- body:通过 HTTP 响应正文判断响应状态。要求响应正文为 JSON 格式且其中包含 code
+ 字段。
+
+### OAuth
+
+定义类 OAuth 的认证流程。其他的认证方式如 apikey 可以直接在 headers 设置密钥,不需要使用这个配置。
+
+OAuth 2.0 是一个授权协议,让 API 客户端有限度地访问网络服务器上的用户数据。oAuth 最常见的流程是授权代码,大多用于服务器端和移动网络应用。在这个流程中,用户使用他们的账户登录到网络应用中,认证码会返回给应用。之后,应用程序可以使用认证码来请求访问令牌,并可能在到期后通过刷新令牌来刷新令牌。
+
+在这个配置中,我们假设认证码已经获取了,用户只需指定令牌申请的过程,该过程可能需要该认证码或只是密码(OAuth 的变体)。
+
+需要配置两个部分:用于获取访问代码的 access 配置和用于令牌刷新的 refresh 配置。其中,refresh 配置是可选的,只有存在单独的刷新流程时才需要配置。
+
+#### access
+
+- url:获取访问码的网址,总是使用POST方法访问。
+- body:获取访问令牌的请求主体。通常情况下,可在这里提供授权码。
+- expire:令牌的过期时间,时间单位是秒,允许使用模板,所以必须是一个字符串。
+
+#### refresh
+
+- url:刷新令牌的网址,总是使用POST方式请求。
+- headers:用于刷新令牌的请求头。通常把令牌放在这里,用于授权。
+- body:刷新令牌的请求主体。当使用头文件来传递刷新令牌时,可能不需要配置此选项。
 
 ## 重载默认设置