juzhiyuan commented on a change in pull request #6318: URL: https://github.com/apache/apisix/pull/6318#discussion_r809032931
########## File path: docs/en/latest/plugins/batch-requests.md ########## @@ -118,23 +118,35 @@ Response is `Array` of [HttpResponse](#httpresponse). ## How to specify custom uri -We can change the default uri in the `plugin_attr` section of `conf/config.yaml`. +We have the [public-api](public-api.md) plugin, customizing the uri becomes even easier. We just need to set the `uri` you want when creating the route and change the configuration of the `public-api` plugin. -| Name | Type | Requirement | Default | Description | -| ---------- | ------ |-------------| ---------------------------- | --------------------------------- | -| uri | string | optional | "/apisix/batch-requests" | uri to use with batch-requests plugin | - -Here is an example: - -```yaml -plugin_attr: - batch-requests: - uri: "/api-gw/batch" +```shell +$ curl http://127.0.0.1:9080/apisix/admin/routes/br -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +{ + "uri": "/batch-requests", + "plugins": { + "public-api": { + "uri": "/apisix/batch-requests" + } + } +}' ``` ## Test Plugin -You can pass your request detail to batch API( `/apisix/batch-requests` ), `apisix` can automatically complete requests via [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining). Such as: +First you need to setup the route for the API that batch request, which will use the [public-api](public-api.md) plugin. + +```shell +$ curl http://127.0.0.1:9080/apisix/admin/routes/br -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +{ + "uri": "/apisix/batch-requests", + "plugins": { + "public-api": {} + } +}' +``` + +Then, you can pass your request detail to batch API( `/apisix/batch-requests` ), APISIX can automatically complete requests via [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining). Such as: Review comment: ```suggestion Then, you can pass your request detail to batch API(`/apisix/batch-requests`), APISIX can automatically complete requests via [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining). Such as: ``` ########## File path: docs/en/latest/plugins/prometheus.md ########## @@ -93,6 +93,20 @@ Then add prometheus plugin: We fetch the metric data from the specified url `/apisix/prometheus/metrics`. +First you need to setup the route for the metrics API, which will use the [public-api](public-api.md) plugin. Review comment: ```suggestion First, you need to set up the route for the metrics API, which will use the [public-api](public-api.md) plugin. ``` ########## File path: docs/zh/latest/plugins/batch-requests.md ########## @@ -122,23 +122,35 @@ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API ## 如何修改自定义 uri -我们可以在 `conf/config.yaml` 的 `plugin_attr` 配置项中修改默认的 `uri` +我们可以使用 [public-api](../../../en/latest/plugins/public-api.md) 插件轻易的设置自定义 uri。只需要在创建路由时设置需要的 uri 并改变 `public-api` 插件的配置即可。 -| 名称 | 类型 | 必选项 | 默认值 | 描述 | -| --------- | ------ | ------ | ---------------------------- | -------------- | -| uri | string | 可选 |"/apisix/batch-requests" | `batch-requests` 插件的自定义 uri | - -配置示例: - -```yaml -plugin_attr: - batch-requests: - uri: "/api-gw/batch" +```shell +$ curl http://127.0.0.1:9080/apisix/admin/routes/br -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +{ + "uri": "/batch-requests", + "plugins": { + "public-api": { + "uri": "/apisix/batch-requests" + } + } +}' ``` ## 测试插件 -你可以将要访问的请求信息传到网关的批量请求接口( `/apisix/batch-requests` )，网关会以 [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining) 的方式自动帮你完成请求。 +首先，你需要为 batch request 的 API 设置一个路由，它将使用 [public-api](public-api.md) 插件。 Review comment: `[public-api](public-api.md)` only has English version? ########## File path: docs/en/latest/plugins/jwt-auth.md ########## @@ -196,6 +196,20 @@ then add jwt-auth plugin in the Consumer page: #### Get the Token in `jwt-auth` Plugin: +First you need to setup the route for the API that sign the token, which will use the [public-api](public-api.md) plugin. Review comment: ```suggestion First, you need to set up the route for the API that signs the token, which will use the [public-api](public-api.md) plugin. ``` -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
