This is an automated email from the ASF dual-hosted git repository.

liubao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-samples.git


The following commit(s) were added to refs/heads/master by this push:
     new 61c65c1  add build and run to samples (#68)
61c65c1 is described below

commit 61c65c13b6cb8ebf46f4f8caee14389965f72f6e
Author: bao liu <[email protected]>
AuthorDate: Tue Mar 2 11:45:47 2021 +0800

    add build and run to samples (#68)
---
 basic/README.md                                    | 54 ++++++++++++++++++++--
 .../servicecomb/samples/ConsumerController.java    |  1 +
 basic/consumer/src/main/resources/application.yml  |  4 +-
 basic/gateway/src/main/resources/application.yml   |  4 +-
 .../servicecomb/samples/ProviderController.java    |  1 +
 basic/provider/src/main/resources/application.yml  |  4 +-
 6 files changed, 59 insertions(+), 9 deletions(-)

diff --git a/basic/README.md b/basic/README.md
index 45ff3a9..b9d6ee3 100644
--- a/basic/README.md
+++ b/basic/README.md
@@ -10,9 +10,33 @@ A Microserivce using Java Chassis with a REST interface. 
Consumer calls provider
 * gateway
 A Microserivce using Java Chassis Edge Service to forward requests to consumer.
 
-# Usage
-Start 3 microservices and open in browser: 
http://localhost:9090/sayHello?name=World
+# Build and Run
 
+* Build
+
+        mvn clean pacakge
+
+* Run provider
+
+  In ${Project}/provider/target/
+  
+        java -jar basic-provider-2.0-SNAPSHOT.jar
+
+* Run consumer
+
+  In ${Project}/consumer/target/
+
+        java -jar basic-consumer-2.0-SNAPSHOT.jar
+
+* Run gateway
+
+  In ${Project}/gateway/target/
+
+        java -jar basic-gateway-2.0-SNAPSHOT.jar
+
+* Testing
+
+Open in browser: http://localhost:9090/sayHello?name=World
 
 # 项目说明
 
@@ -29,4 +53,28 @@ Start 3 microservices and open in browser: 
http://localhost:9090/sayHello?name
 
 ## 使用
 
-启动3个微服务, 然后通过界面访问: http://localhost:9090/sayHello?name=World
+* 编译
+
+        mvn clean pacakge
+
+* 启动 provider
+
+  进入目录 ${Project}/provider/target/
+  
+        java -jar basic-provider-2.0-SNAPSHOT.jar
+
+* 启动 consumer
+
+  进入目录 ${Project}/consumer/target/
+
+        java -jar basic-consumer-2.0-SNAPSHOT.jar
+
+* 启动 gateway
+
+  进入目录 ${Project}/gateway/target/
+
+        java -jar basic-gateway-2.0-SNAPSHOT.jar
+
+* 测试
+
+启动3个微服务后, 然后通过界面访问: http://localhost:9090/sayHello?name=World
diff --git 
a/basic/consumer/src/main/java/org/apache/servicecomb/samples/ConsumerController.java
 
b/basic/consumer/src/main/java/org/apache/servicecomb/samples/ConsumerController.java
index 700fae0..4ed0ecd 100644
--- 
a/basic/consumer/src/main/java/org/apache/servicecomb/samples/ConsumerController.java
+++ 
b/basic/consumer/src/main/java/org/apache/servicecomb/samples/ConsumerController.java
@@ -29,6 +29,7 @@ public class ConsumerController {
   @RpcReference(schemaId = "ProviderController", microserviceName = "provider")
   private ProviderService providerService;
 
+  // consumer service which delegate the implementation to provider service.
   @GetMapping("/sayHello")
   public String sayHello(@RequestParam("name") String name) {
     return providerService.sayHello(name);
diff --git a/basic/consumer/src/main/resources/application.yml 
b/basic/consumer/src/main/resources/application.yml
index 01249ce..9a98590 100644
--- a/basic/consumer/src/main/resources/application.yml
+++ b/basic/consumer/src/main/resources/application.yml
@@ -43,9 +43,9 @@ servicecomb:
   rest:
     address: 0.0.0.0:9092  # should be same with server.port to use web 
container
 
-# Using Huawei Cloud Service Engine Professional Edition, AK/SK is required
+# Configure AK/SK credentials if needed. Default not enabled.
 #  credentials:
-#    akskEnabled: true
+#    akskEnabled: false
 #    accessKey: add your ak/sk from huaweicloud
 #    secretKey: add your ak/sk from huaweicloud
 #    akskCustomCipher: default
diff --git a/basic/gateway/src/main/resources/application.yml 
b/basic/gateway/src/main/resources/application.yml
index 7ed512d..b625f41 100644
--- a/basic/gateway/src/main/resources/application.yml
+++ b/basic/gateway/src/main/resources/application.yml
@@ -55,9 +55,9 @@ servicecomb:
               microserviceName: consumer
               versionRule: 0.0.0+
 
-# Using Huawei Cloud Service Engine Professional Edition, AK/SK is required
+# Configure AK/SK credentials if needed. Default not enabled.
 #  credentials:
-#    akskEnabled: true
+#    akskEnabled: false
 #    accessKey: add your ak/sk from huaweicloud
 #    secretKey: add your ak/sk from huaweicloud
 #    akskCustomCipher: default
diff --git 
a/basic/provider/src/main/java/org/apache/servicecomb/samples/ProviderController.java
 
b/basic/provider/src/main/java/org/apache/servicecomb/samples/ProviderController.java
index 67a07c1..6eea777 100644
--- 
a/basic/provider/src/main/java/org/apache/servicecomb/samples/ProviderController.java
+++ 
b/basic/provider/src/main/java/org/apache/servicecomb/samples/ProviderController.java
@@ -25,6 +25,7 @@ import org.springframework.web.bind.annotation.RequestParam;
 @RestSchema(schemaId = "ProviderController")
 @RequestMapping(path = "/")
 public class ProviderController {
+  // a very simple service to echo the request parameter
   @GetMapping("/sayHello")
   public String sayHello(@RequestParam("name") String name) {
     return "Hello " + name;
diff --git a/basic/provider/src/main/resources/application.yml 
b/basic/provider/src/main/resources/application.yml
index 3c85cea..ab73b03 100644
--- a/basic/provider/src/main/resources/application.yml
+++ b/basic/provider/src/main/resources/application.yml
@@ -43,9 +43,9 @@ servicecomb:
   rest:
     address: 0.0.0.0:9093 # should be same with server.port to use web 
container
 
-# Using Huawei Cloud Service Engine Professional Edition, AK/SK is required
+# Configure AK/SK credentials if needed. Default not enabled.
 #  credentials:
-#    akskEnabled: true
+#    akskEnabled: false
 #    accessKey: add your ak/sk from huaweicloud
 #    secretKey: add your ak/sk from huaweicloud
 #    akskCustomCipher: default

Reply via email to