docs: update public API relative usage by bzp2010 · Pull Request #6318 · apache/apisix

bzp2010 · 2022-02-14T10:24:58Z

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:

Did you explain what problem does this PR solve? Or what new features have been added?
Have you added corresponding test cases?
Have you modified the corresponding document?
Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

tzssangglass · 2022-02-15T01:19:33Z

+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 '


Suggested change

$ 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 '

bzp2010 · 2022-02-16T12:40:53Z

Hi, @spacewander. Please help check it out, thanks!

juzhiyuan · 2022-02-17T13:17:12Z

 ## 测试插件

-你可以将要访问的请求信息传到网关的批量请求接口( `/apisix/batch-requests` )，网关会以 [http pipeline](https://en.wikipedia.org/wiki/HTTP_pipelining) 的方式自动帮你完成请求。
+首先，你需要为 batch request 的 API 设置一个路由，它将使用 [public-api](public-api.md) 插件。


[public-api](public-api.md) only has English version?

broken link fixed

spacewander · 2022-02-18T05:01:02Z

+}'
+```
+
+Then, we can get the metrics.


We don't need to do it for prometheus, which uses a different port.

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.

The default port of Prometheus metrics is 9091, not the 9080.

It is not recommended to configure the port to 9080, which abuses the 9080 port and should be only used in the CI.

I think we should remove the example of public-api in prometheus. Better not encourage the abuse.

@spacewander changes rolled back

Co-authored-by: 琚致远 <[email protected]>

juzhiyuan · 2022-02-21T03:50:33Z

Hi @bzp2010, please have a check on this.

iamayushdas

English Docs are good to go✅

* 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) ...

bzp2010 added 2 commits February 14, 2022 18:22

docs: update public API relative usage

98aea6c

fix: lint

199b64d

bzp2010 self-assigned this Feb 14, 2022

bzp2010 requested review from juzhiyuan, shuaijinchao, spacewander and tzssangglass February 14, 2022 13:39

bzp2010 marked this pull request as ready for review February 14, 2022 13:39

juzhiyuan reviewed Feb 15, 2022

View reviewed changes

Comment thread docs/en/latest/plugins/jwt-auth.md

shuaijinchao previously approved these changes Feb 15, 2022

View reviewed changes

tzssangglass reviewed Feb 15, 2022

View reviewed changes

docs: fix wrong curl demo

03694e7

bzp2010 dismissed shuaijinchao’s stale review via 03694e7 February 16, 2022 02:41

tzssangglass previously approved these changes Feb 16, 2022

View reviewed changes

shuaijinchao previously approved these changes Feb 17, 2022

View reviewed changes

juzhiyuan reviewed Feb 17, 2022

View reviewed changes

spacewander requested changes Feb 18, 2022

View reviewed changes

docs: fix broken document link

91a32a9

bzp2010 dismissed stale reviews from shuaijinchao and tzssangglass via 91a32a9 February 21, 2022 02:08

fix: typo

540f1ed

Co-authored-by: 琚致远 <[email protected]>

bzp2010 requested a review from spacewander February 21, 2022 03:01

bzp2010 added 5 commits February 21, 2022 15:29

docs: add use cases for different port

bf7839e

docs: fix configuration file typo (apache#6395)

24bd6c4

docs: fix logger

b427a7a

Merge branch 'master' into doc-public-api-relative-2

013718e

docs: recover prometheus usage

ff3a704

bzp2010 requested a review from tzssangglass February 21, 2022 10:23

bzp2010 requested review from juzhiyuan and shuaijinchao February 21, 2022 10:23

iamayushdas approved these changes Feb 21, 2022

View reviewed changes

tzssangglass approved these changes Feb 21, 2022

View reviewed changes

spacewander approved these changes Feb 22, 2022

View reviewed changes

spacewander merged commit ecf08c6 into apache:master Feb 22, 2022

	$ 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 '

Uh oh!

Conversation

bzp2010 commented Feb 14, 2022

What this PR does / why we need it:

Pre-submission checklist:

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bzp2010 commented Feb 16, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bzp2010 Feb 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

juzhiyuan commented Feb 21, 2022

Uh oh!

iamayushdas left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

bzp2010 Feb 21, 2022 •

edited

Loading