ShiningRush commented on a change in pull request #1388: feature: add api aggregate plugin. URL: https://github.com/apache/incubator-apisix/pull/1388#discussion_r410804874
########## File path: doc/plugins/api-aggregate-cn.md ########## @@ -0,0 +1,135 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +# [English](api-aggregate.md) + +# 目录 + +- [**简介**](#简介) +- [**属性**](#属性) +- [**如何启用**](#如何启用) +- [**聚合接口请求/响应**](#聚合接口请求/响应) +- [**测试插件**](#测试插件) +- [**禁用插件**](#禁用插件) + +## 简介 + +`api-aggregate` 插件可以让你在以 [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining) 的方式在网关聚合多个http请求。 + +## 属性 + +无 + +## 如何启用 + +本插件默认启用。 + +## 聚合接口请求/响应 +插件会为 `apisix` 创建一个 `/apisix/aggregate` 的聚合接口来处理你的聚合请求。 + +### 接口请求参数: + +| 参数名 | 类型 | 可选 | 默认值 | 描述 | +| --- | --- | --- | --- | --- | +| query | Object | Yes | | 给所有请求都携带的 `QueryString` | +| headers | Object | Yes | | 给所有请求都携带的 `Header` | +| timeout | Number | Yes | 3000 | 聚合请求的超时时间，单位为 `ms` | +| pipeline | [HttpRequest](#Request) | No | | Http 请求的详细信息 | + +#### HttpRequest +| 参数名 | 类型 | 可选 | 默认值 | 描述 | +| --- | --- | --- | --- | --- | +| version | Enum | Yes | 1.1 | 请求用的 `http` 协议版本，可以使用 `1.0` or `1.1` | +| method | Enum | Yes | GET | 请求使用的 `http` 方法，例如：`GET`. | +| query | Object | Yes | | 独立请求所携带的 `QueryString`, 如果 `Key` 和全局的有冲突，以此设置为主。 | +| headers | Object | Yes | | 独立请求所携带的 `Header`, 如果 `Key` 和全局的有冲突，以此设置为主。 | +| path | String | No | | 请求路径 | +| body | String | Yes | | 请求体 | + +### 接口响应参数： +返回值为一个 [HttpResponse](#HttpResponse) 的 `数组`。 + +#### HttpResponse +| 参数名 | 类型 | 描述 | +| --- | --- | --- | --- | --- | +| status | Integer | Http 请求的状态码 | +| reason | String | Http 请求的返回信息 | +| body | String | Http 请求的响应体 | +| headers | Object | Http 请求的响应头 | + +## 测试插件 + +你可以将要访问的请求信息传到网关的聚合接口( `/apisix/aggregate` )，网关会以 [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining) 的方式自动帮你完成请求。 +```shell +curl --location --request POST 'http://127.0.0.1:9080/apisix/aggregate' \ Review comment: "API aggregation should be controlled by the administrator" Do you mean the enable of the features or the details of how to aggregate request? Maybe we can have a talk in wechat, it can reach a consensus easily. @moonming @membphis Do you aggree? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
