docs: update public API relative usage #6318
Conversation
bzp2010
requested review from
juzhiyuan,
spacewander,
shuaijinchao and
tzssangglass
docs/en/latest/plugins/jwt-auth.md
Outdated
| First you need to setup the route for the API that sign the token, which will use the [public-api](public-api.md) plugin. | ||
|
|
||
| ```shell | ||
| $ curl http://127.0.0.1:9080/apisix/admin/routes/ -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' |
There was a problem hiding this comment.
| $ curl http://127.0.0.1:9080/apisix/admin/routes/ -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' | |
| $ curl http://127.0.0.1:9080/apisix/admin/routes/jwt-sign -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' |
|
Hi, @spacewander. Please help check it out, thanks! |
| ``` | ||
|
|
||
| ## 测试插件 | ||
|
|
||
| 你可以将要访问的请求信息传到网关的批量请求接口( `/apisix/batch-requests` )，网关会以 [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining) 的方式自动帮你完成请求。 | ||
| 首先，你需要为 batch request 的 API 设置一个路由，它将使用 [public-api](public-api.md) 插件。 |
There was a problem hiding this comment.
[public-api](public-api.md) only has English version?
docs/en/latest/plugins/prometheus.md
Outdated
| }' | ||
| ``` | ||
|
|
||
| Then, we can get the metrics. |
There was a problem hiding this comment.
We don't need to do it for prometheus, which uses a different port.
There was a problem hiding this comment.
I think now that we have introduced public-api plugin, can we reduce the existence of APIs with special configuration items on these plugins and let users give priority to using public-api plugin to realize similar functions, such as prometheus plugin and batch-requests plugins.
There was a problem hiding this comment.
The default port of Prometheus metrics is 9091, not the 9080.
There was a problem hiding this comment.
It is not recommended to configure the port to 9080, which abuses the 9080 port and should be only used in the CI.
There was a problem hiding this comment.
I think we should remove the example of public-api in prometheus. Better not encourage the abuse.
There was a problem hiding this comment.
@spacewander changes rolled back
bzp2010
dismissed stale reviews from shuaijinchao and tzssangglass
via
91a32a9
|
Hi @bzp2010, please have a check on this. |
* upstream: (52 commits) feat: add kubernetes discovery module (apache#4880) docs: fix For L7 proxy -> For L4 proxy (apache#6423) fix(deps): upgrade jsonschema to 0.9.8 (apache#6407) docs: translate Chinese to English in en clickhouse-logger (apache#6416) docs: add zh proxy-control.md&modify other doc error (apache#6346) docs: update public API relative usage (apache#6318) docs(cn): remove datadog from sidebar & fix doc lint conf (apache#6411) fix(request-validation): should not limit the urlencoded post args number (apache#6396) docs: fix configuration file typo (apache#6395) docs(extern-plugin): the implementation of runner (apache#6336) docs: polishing skywalking-logger plugin's docs (apache#6377) doc: adjust the directory structure of observability's documents (apache#6391) change(admin): empty nodes should be encoded as array (apache#6384) fix: should not limit the header number (apache#6379) ci: remove unnecessary tmate action (apache#6367) fix(opentelemetry): batch_span_processor export zero length spans (apache#6349) feat(graphql): support http get and post json request (apache#6343) feat: support for configuring the number of etcd health check retries (apache#6322) feat(wasm): support getting request body (apache#6325) fix(hmac-auth): hmac-auth plugin sort array param (apache#6314) ...
What this PR does / why we need it:
Update the usage in the documentation of some plugins that use the public API feature.
Pre-submission checklist: