This is an automated email from the ASF dual-hosted git repository.
alexstocks pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/dubbo-go-pixiu.git
The following commit(s) were added to refs/heads/develop by this push:
new 5ddf2ce4 docs:format and change samples link (#556)
5ddf2ce4 is described below
commit 5ddf2ce48add14946cc530b913aeb41499bf6ace
Author: baerwang <[email protected]>
AuthorDate: Tue May 16 15:11:29 2023 +0800
docs:format and change samples link (#556)
Co-authored-by: baerwang <[email protected]>
---
docs/index.md | 1 -
docs/sample/dubbo/dubbo-body(http).md | 2 +-
docs/sample/dubbo/dubbo-body.md | 5 +-
docs/sample/dubbo/dubbo-mix.md | 2 +-
docs/sample/dubbo/dubbo-multi.md | 3 +-
docs/sample/dubbo/dubbo-query.md | 2 +-
docs/sample/dubbo/dubbo-registry.md | 70 +++++++++++++--------------
docs/sample/dubbo/dubbo-universality.md | 14 +++---
docs/sample/dubbo/dubbo-uri.md | 2 +-
docs/sample/dubbo/dubbo.md | 3 +-
docs/sample/dubbo/http-body.md | 2 +-
docs/sample/dubbo/http-uri.md | 32 +++++++-----
docs/sample/zh-cn/dubbo/dubbo-body.md | 2 +-
docs/sample/zh-cn/dubbo/dubbo-mix.md | 2 +-
docs/sample/zh-cn/dubbo/dubbo-multi.md | 2 +-
docs/sample/zh-cn/dubbo/dubbo-query.md | 2 +-
docs/sample/zh-cn/dubbo/dubbo-universality.md | 2 +-
docs/sample/zh-cn/dubbo/dubbo-uri.md | 2 +-
docs/sample/zh-cn/dubbo/dubbo.md | 2 +-
docs/user/config.md | 32 ++++++------
docs/user/metric.md | 4 +-
docs/user/start.md | 3 +-
22 files changed, 98 insertions(+), 93 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index c50251a0..8c232eab 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -15,7 +15,6 @@
* [Tracing](sample/others/jaeger.md)
* [springcloud](sample/springcloud/README.md)
-
## [Developer Guide](developer/README.md)
* [Concept](developer/concept.md)
diff --git a/docs/sample/dubbo/dubbo-body(http).md
b/docs/sample/dubbo/dubbo-body(http).md
index 4e0caab1..ca78ad76 100644
--- a/docs/sample/dubbo/dubbo-body(http).md
+++ b/docs/sample/dubbo/dubbo-body(http).md
@@ -54,6 +54,6 @@ curl host:port/api/v1/test-dubbo/user -X POST -d '{"name":
"tiecheng","id": "000
```json
{
- "message": "data is exist"
+ "message": "data is exist"
}
```
diff --git a/docs/sample/dubbo/dubbo-body.md b/docs/sample/dubbo/dubbo-body.md
index 3b445da2..20424ef6 100644
--- a/docs/sample/dubbo/dubbo-body.md
+++ b/docs/sample/dubbo/dubbo-body.md
@@ -1,6 +1,6 @@
# Get the parameter from the body
-> POST request
[samples](https://github.com/dubbogo/dubbo-go-proxy/tree/develop/samples/dubbogo/simple/body)
+> POST request
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/body)
## Passthroughs
@@ -94,7 +94,8 @@ If first add, return like:
"name": "dubbogo"
}
```
-If you add user multi, return like:
+
+If you add user multi, return like:
```json
{
diff --git a/docs/sample/dubbo/dubbo-mix.md b/docs/sample/dubbo/dubbo-mix.md
index 6a4fd433..79054e12 100644
--- a/docs/sample/dubbo/dubbo-mix.md
+++ b/docs/sample/dubbo/dubbo-mix.md
@@ -1,6 +1,6 @@
# Get the parameter from the part of uri,query,body
-> GET request
[samples](https://github.com/dubbogo/dubbo-go-proxy/tree/develop/samples/dubbogo/simple/mix)
+> GET request
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/mix)
## Simple Demo
diff --git a/docs/sample/dubbo/dubbo-multi.md b/docs/sample/dubbo/dubbo-multi.md
index ec8314bb..308c191a 100644
--- a/docs/sample/dubbo/dubbo-multi.md
+++ b/docs/sample/dubbo/dubbo-multi.md
@@ -1,6 +1,6 @@
# Get the parameter from the part of uri
-> GET request
[sample](https://github.com/dubbogo/dubbo-go-proxy/tree/develop/sample/dubbo/multi)
+> GET request
[sample](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/multi)
## Simple Demo
@@ -95,6 +95,7 @@ resources:
```
### server config
+
```yaml
# dubbo server yaml configure file
# application config
diff --git a/docs/sample/dubbo/dubbo-query.md b/docs/sample/dubbo/dubbo-query.md
index af160c71..875736d5 100644
--- a/docs/sample/dubbo/dubbo-query.md
+++ b/docs/sample/dubbo/dubbo-query.md
@@ -1,6 +1,6 @@
# Get the parameter from the query
-> GET request
[samples](https://github.com/dubbogo/dubbo-go-proxy/tree/develop/samples/dubbogo/simple/query)
+> GET request
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/query)
## Simple Demo
diff --git a/docs/sample/dubbo/dubbo-registry.md
b/docs/sample/dubbo/dubbo-registry.md
index d32c4013..6e2b3959 100644
--- a/docs/sample/dubbo/dubbo-registry.md
+++ b/docs/sample/dubbo/dubbo-registry.md
@@ -14,39 +14,39 @@ static_resources:
address: "0.0.0.0"
port: 8881
filter_chains:
- filters:
- - name: dgp.filter.httpconnectionmanager
- config:
- route_config:
- routes:
- - match:
- prefix: "/"
- route:
- cluster: "test-dubbo"
- cluster_not_found_response_code: 505
- http_filters:
- - name: dgp.filter.http.apiconfig
- config:
- dynamic: true
- dynamic_adapter: test
- # configure the dubbogo registry
- - name: dgp.filter.http.dubboproxy
- config:
- dubboProxyConfig:
- registries:
- "zookeeper":
- protocol: "zookeeper"
- timeout: "3s"
- address: "127.0.0.1:2181"
- username: ""
- password: ""
- timeout_config:
- connect_timeout: 5s
- request_timeout: 5s
- - name: dgp.filter.http.response
- config:
- server_name: "test_http_dubbo"
- generate_request_id: false
+ filters:
+ - name: dgp.filter.httpconnectionmanager
+ config:
+ route_config:
+ routes:
+ - match:
+ prefix: "/"
+ route:
+ cluster: "test-dubbo"
+ cluster_not_found_response_code: 505
+ http_filters:
+ - name: dgp.filter.http.apiconfig
+ config:
+ dynamic: true
+ dynamic_adapter: test
+ # configure the dubbogo registry
+ - name: dgp.filter.http.dubboproxy
+ config:
+ dubboProxyConfig:
+ registries:
+ "zookeeper":
+ protocol: "zookeeper"
+ timeout: "3s"
+ address: "127.0.0.1:2181"
+ username: ""
+ password: ""
+ timeout_config:
+ connect_timeout: 5s
+ request_timeout: 5s
+ - name: dgp.filter.http.response
+ config:
+ server_name: "test_http_dubbo"
+ generate_request_id: false
config:
idle_timeout: 5s
read_timeout: 5s
@@ -75,13 +75,13 @@ static_resources:
timeout: "5s"
```
-We should configure the `dgp.filter.http.dubboproxy` filter in the
configuration file.
+We should configure the `dgp.filter.http.dubboproxy` filter in the
configuration file.
## Test
The default API path is `/application/interface/version/method`. The types and
values of the parameters should be placed in the request body.
-Run command curl using:
+Run command curl using:
```
curl
http://localhost:8881/BDTService/com.dubbogo.pixiu.UserService/1.0.0/GetUserByCode
-X POST -d '{"types":"int", "values":1}'
diff --git a/docs/sample/dubbo/dubbo-universality.md
b/docs/sample/dubbo/dubbo-universality.md
index d344914e..770da4f7 100644
--- a/docs/sample/dubbo/dubbo-universality.md
+++ b/docs/sample/dubbo/dubbo-universality.md
@@ -1,6 +1,6 @@
# Use dubbo request universality
-> POST request
[samples](https://github.com/dubbogo/dubbo-go-proxy/tree/develop/samples/dubbogo/simple/proxy)
+> POST request
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/proxy)
## Suggest
@@ -132,7 +132,7 @@ Use for dubbogo `GenericService#Invoke` func arg 1rd param.
- opt.group
-Dubbo group in `ReferenceConfig#Group`.
+Dubbo group in `ReferenceConfig#Group`.
- opt.version
@@ -152,22 +152,20 @@ Use for dubbogo `GenericService#Invoke` func arg 3rd
param.
#### Explain
-##### Single params
+##### Single params
request body
```json
{
- "types": [
- "string"
- ],
+ "types": ["string"],
"values": "tc"
}
```
```yaml
- - name: requestBody.types
- mapTo: opt.types
+ - name: requestBody.types
+ mapTo: opt.types
```
- `requestBody.types` means body content with types key.
diff --git a/docs/sample/dubbo/dubbo-uri.md b/docs/sample/dubbo/dubbo-uri.md
index 14a2d83b..af0cc89c 100644
--- a/docs/sample/dubbo/dubbo-uri.md
+++ b/docs/sample/dubbo/dubbo-uri.md
@@ -1,6 +1,6 @@
# Get the parameter from the uri
-> GET request
[samples](https://github.com/dubbogo/dubbo-go-proxy/tree/develop/samples/dubbogo/simple/uri)
+> GET request
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/uri)
## Simple Demo
diff --git a/docs/sample/dubbo/dubbo.md b/docs/sample/dubbo/dubbo.md
index 193d40e0..30a091c2 100644
--- a/docs/sample/dubbo/dubbo.md
+++ b/docs/sample/dubbo/dubbo.md
@@ -11,14 +11,13 @@
* [dubbo-incomplete](dubbo-incomplete.md)
* [dubbo-registry](dubbo-registry.md)
-
### http to http-protocl-base dubbo request
* [http-body](http-body.md)
* [http-query](http-query.md)
* [http-uri](http-uri.md)
-> Based on
[samples](https://github.com/dubbogo/dubbo-go-proxy/tree/develop/samples/dubbogo/simple)
+> Based on
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple)
How do I run a simple test example [document](dubbo-simple-run.md)
diff --git a/docs/sample/dubbo/http-body.md b/docs/sample/dubbo/http-body.md
index 038ff2b4..325ab53c 100644
--- a/docs/sample/dubbo/http-body.md
+++ b/docs/sample/dubbo/http-body.md
@@ -44,7 +44,7 @@ curl host:port/api/v1/test-http/user -X POST -d '{"name":
"tiecheng1","code": 4,
}
```
-- If you add user multi, return like:
+- If you add user multi, return like:
```json
{
diff --git a/docs/sample/dubbo/http-uri.md b/docs/sample/dubbo/http-uri.md
index 1a4e921c..782ffba1 100644
--- a/docs/sample/dubbo/http-uri.md
+++ b/docs/sample/dubbo/http-uri.md
@@ -83,8 +83,11 @@ resources:
- name: queryStrings.time
mapTo: requestBody.time
```
+
## Sample Requests
+
### Passthrough Get request
+
```bash
curl --request GET 'localhost:8888/api/v1/test-http/user?name=joe2'
```
@@ -95,16 +98,17 @@ curl --request GET
'localhost:8888/api/v1/test-http/user?name=joe2'
```json
{
- "id": "XVlBz",
- "name": "joe2",
- "age": 20,
- "time": "2021-01-01T00:00:00Z"
+ "id": "XVlBz",
+ "name": "joe2",
+ "age": 20,
+ "time": "2021-01-01T00:00:00Z"
}
```
- Not found, return: nil
### Mix Post request
+
```bash
curl --request POST
'localhost:8888/api/v1/test-http/user/tc2?time=2021-01-01T00:00:00Z' \
--header 'Content-Type: application/json' \
@@ -114,26 +118,30 @@ curl --request POST
'localhost:8888/api/v1/test-http/user/tc2?time=2021-01-01T00
```
#### Response
+
```json
{
- "id": "XVlBz",
- "name": "tc2",
- "age": 19,
- "time": "2021-01-01T00:00:00Z"
+ "id": "XVlBz",
+ "name": "tc2",
+ "age": 19,
+ "time": "2021-01-01T00:00:00Z"
}
```
+
### Mix GET request
+
```bash
curl --request GET 'localhost:8888/api/v1/test-http/user/tc'
```
#### Response
+
```json
{
- "id": "0001",
- "name": "tc",
- "age": 18,
- "time": "2020-12-28T13:38:25.687309+08:00"
+ "id": "0001",
+ "name": "tc",
+ "age": 18,
+ "time": "2020-12-28T13:38:25.687309+08:00"
}
```
diff --git a/docs/sample/zh-cn/dubbo/dubbo-body.md
b/docs/sample/zh-cn/dubbo/dubbo-body.md
index 65878452..3d10f53d 100644
--- a/docs/sample/zh-cn/dubbo/dubbo-body.md
+++ b/docs/sample/zh-cn/dubbo/dubbo-body.md
@@ -1,6 +1,6 @@
# 从请求体里面获取参数
-> POST 请求
[samples](https://github.com/apache/dubbo-go-pixiu/tree/develop/samples/dubbogo/simple/body)
+> POST 请求
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/body)
## 透传
diff --git a/docs/sample/zh-cn/dubbo/dubbo-mix.md
b/docs/sample/zh-cn/dubbo/dubbo-mix.md
index ce40e144..9723fd5d 100644
--- a/docs/sample/zh-cn/dubbo/dubbo-mix.md
+++ b/docs/sample/zh-cn/dubbo/dubbo-mix.md
@@ -1,6 +1,6 @@
# 从 URI，Query，Body 各个部分获取参数
-> GET 请求
[samples](https://github.com/apache/dubbo-go-pixiu/tree/develop/samples/dubbogo/simple/mix)
+> GET 请求
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/mix)
## 简单示例
diff --git a/docs/sample/zh-cn/dubbo/dubbo-multi.md
b/docs/sample/zh-cn/dubbo/dubbo-multi.md
index 0706f933..1cb9a6d1 100644
--- a/docs/sample/zh-cn/dubbo/dubbo-multi.md
+++ b/docs/sample/zh-cn/dubbo/dubbo-multi.md
@@ -1,6 +1,6 @@
# 从 URI获取参数
-> GET 请求
[sample](https://github.com/apache/dubbo-go-pixiu/tree/develop/sample/dubbo/multi)
+> GET 请求
[sample](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/multi)
## 简单示例
diff --git a/docs/sample/zh-cn/dubbo/dubbo-query.md
b/docs/sample/zh-cn/dubbo/dubbo-query.md
index e94ac786..bf280e06 100644
--- a/docs/sample/zh-cn/dubbo/dubbo-query.md
+++ b/docs/sample/zh-cn/dubbo/dubbo-query.md
@@ -1,6 +1,6 @@
# 从表单请求里面获取参数
-> GET 请求
[samples](https://github.com/apache/dubbo-go-pixiu/tree/develop/samples/dubbogo/simple/query)
+> GET 请求
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/query)
## 简单示例
diff --git a/docs/sample/zh-cn/dubbo/dubbo-universality.md
b/docs/sample/zh-cn/dubbo/dubbo-universality.md
index c4ccbeb8..33224e79 100644
--- a/docs/sample/zh-cn/dubbo/dubbo-universality.md
+++ b/docs/sample/zh-cn/dubbo/dubbo-universality.md
@@ -1,6 +1,6 @@
# 使用 dubbo 通用性请求
-> POST 请求
[samples](https://github.com/dubbogo/dubbo-go-proxy/tree/develop/samples/dubbogo/simple/proxy)
+> POST 请求
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/proxy)
## 建议
diff --git a/docs/sample/zh-cn/dubbo/dubbo-uri.md
b/docs/sample/zh-cn/dubbo/dubbo-uri.md
index f3f6ad49..7ba74569 100644
--- a/docs/sample/zh-cn/dubbo/dubbo-uri.md
+++ b/docs/sample/zh-cn/dubbo/dubbo-uri.md
@@ -1,6 +1,6 @@
# 从请求的URI部分获取参数
-> GET 请求
[samples](https://github.com/dubbogo/dubbo-go-proxy/tree/develop/samples/dubbogo/simple/uri)
+> GET 请求
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple/uri)
## 简单示例
diff --git a/docs/sample/zh-cn/dubbo/dubbo.md b/docs/sample/zh-cn/dubbo/dubbo.md
index c2c4c168..a3018919 100644
--- a/docs/sample/zh-cn/dubbo/dubbo.md
+++ b/docs/sample/zh-cn/dubbo/dubbo.md
@@ -8,7 +8,7 @@
* [dubbo-error](../dubbo-error.md)
* [dubbo-incomplete](../dubbo-incomplete.md)
-> 基于的例子
[samples](https://github.com/apache/dubbo-go-pixiu/tree/develop/samples/dubbogo/simple)
+> 基于的例子
[samples](https://github.com/apache/dubbo-go-pixiu-samples/tree/main/dubbogo/simple)
如何运行简单的测试例子[文档](dubbo-simple-run.md)
diff --git a/docs/user/config.md b/docs/user/config.md
index 9c1c0829..79136681 100644
--- a/docs/user/config.md
+++ b/docs/user/config.md
@@ -1,5 +1,3 @@
-
-
### Config
Pixiu supports specifying local config file with argument `-c` which you can
find in those samples pixiu dir.
@@ -22,21 +20,21 @@ static_resources:
address: "0.0.0.0"
port: 8888
filter_chains:
- filters:
- - name: dgp.filter.httpconnectionmanager
- config:
- route_config:
- routes:
- - match:
- prefix: "/user"
- route:
- cluster: "user"
- cluster_not_found_response_code: 505
- http_filters:
- - name: dgp.filter.http.httpproxy
- config:
- - name: dgp.filter.http.response
- config:
+ filters:
+ - name: dgp.filter.httpconnectionmanager
+ config:
+ route_config:
+ routes:
+ - match:
+ prefix: "/user"
+ route:
+ cluster: "user"
+ cluster_not_found_response_code: 505
+ http_filters:
+ - name: dgp.filter.http.httpproxy
+ config:
+ - name: dgp.filter.http.response
+ config:
clusters:
- name: "user"
lb_policy: "lb"
diff --git a/docs/user/metric.md b/docs/user/metric.md
index dd0b395b..531f710a 100644
--- a/docs/user/metric.md
+++ b/docs/user/metric.md
@@ -1,9 +1,11 @@
# Metric
## Enable
+
You can enable the metric in config.yaml as follows.
-Config pixiu's ip and prometheus_port below in your prometheus config file
+Config pixiu's ip and prometheus_port below in your prometheus config file
will allow prometheus to scrape the metric generated by pixiu.
+
```yaml
metric:
enable: true
diff --git a/docs/user/start.md b/docs/user/start.md
index 871e3ff5..5bb43a14 100644
--- a/docs/user/start.md
+++ b/docs/user/start.md
@@ -2,7 +2,6 @@
How to start the dubbo-go-pixiu
-
#### 1 cd samples dir
```
@@ -27,6 +26,7 @@ prepare command will prepare dubbo-server and pixiu config
file and start docker
```
if prepare config file manually, notice:
+
- modify $PROJECT_DIR in conf.yaml to absolute path in your compute
#### 3 start dubbo or http server
@@ -47,7 +47,6 @@ if run pixiu manually, use command as below
go run cmd/pixiu/*.go gateway start -c
/[absolute-path]/dubbo-go-pixiu/samples/dubbo/simple/body/pixiu/conf.yaml
```
-
#### 5. Try a request
use curl to try or use unit test
