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-java-chassis.git
The following commit(s) were added to refs/heads/master by this push:
new 17f3f37 [SCB-1575] Add README for Service-Center-Client
17f3f37 is described below
commit 17f3f37d0f0c3579b2cbbd8e969c731b204aff41
Author: zhouzhongyuan <[email protected]>
AuthorDate: Sat Nov 9 18:05:21 2019 +0800
[SCB-1575] Add README for Service-Center-Client
To help users use the service-center-client more easily, add a README to
the service-center-client.
---
client/service-center-client/README.md | 98 ++++++++++++++++++++++++++++++++++
1 file changed, 98 insertions(+)
diff --git a/client/service-center-client/README.md
b/client/service-center-client/README.md
new file mode 100644
index 0000000..01bd20a
--- /dev/null
+++ b/client/service-center-client/README.md
@@ -0,0 +1,98 @@
+## ServiceComb-Service-Center Client for Java
+
+ Sample Java client for ServiceComb-Service-Center HTTP API.
+ If you want more information about the ServiceComb-Service-Center HTTP API,
go
[here](https://github.com/apache/servicecomb-service-center/blob/master/server/core/swagger/v4.yaml).
+
+### Build & Install
+
+ local Build from source :
+ ```
+ maven clean install
+ ```
+
+ add dependency to maven
+ ```
+ <dependency>
+ <groupId>org.apache.servicecomb</groupId>
+ <artifactId>service-center-client</artifactId>
+ <version>2.0.0-SNAPSHOT</version>
+ </dependency>
+ ```
+
+
+### Basic Usage
+
+#### Case 1: Health check
+```Java
+ServiceCenterClient client = new ServiceCenterClient();
+
+//get service-center instance
+MicroserviceInstancesResponse instances = client.getServiceCenterInstances();
+```
+
+#### Case 2: Register microservice
+```Java
+ServiceCenterClient client = new ServiceCenterClient();
+
+// state Microservice object, and you have to set a serviceName
+Microservice microservice = new Microservice();
+microservice.setServiceName("Test");
+microservice.setServiceId("111111");
+
+//register microservice
+String response = client.registerMicroservice(microservice);
+```
+
+#### Case 3: Get microservice list
+```Java
+ServiceCenterClient client = new ServiceCenterClient();
+
+//get services lists
+MicroservicesResponse services = client.getMicroserviceList();
+```
+
+#### Case 4: Register service instance
+```Java
+ServiceCenterClient client = new ServiceCenterClient();
+
+//state MicroserviceInstance object, you have to set existed serviceId
+MicroserviceInstance instance = new MicroserviceInstance();
+instance.setServiceId("222222");
+
+//register service instanceId, return instanceId
+String instanceId = client.registerMicroserviceInstance(instance, "222222");
+```
+
+#### Case 5: Get service instances list
+```Java
+ServiceCenterClient client = new ServiceCenterClient();
+
+// get instances list with servcieId being "222222"
+MicroserviceInstancesResponse instances =
client.getMicroserviceInstanceList("222222");
+```
+
+#### Case 6: Heartbeats
+```Java
+ServiceCenterClient client = new ServiceCenterClient();
+
+//all services and all instances send heartbeats
+MicroservicesResponse services = client.getMicroserviceList();
+for(Microservice microservice : services.getServices())
+{
+ for (MicroserviceInstance instance:
client.getMicroserviceInstanceList(microservice.getServiceId()).getInstances())
+ {
+ client.sendHeartBeats(new
HeartbeatsRequest(microservice.getServiceId(),instance.getInstanceId()));
+ }
+}
+```
+
+#### Other API
+You can see client API code and tests, go
[here](https://github.com/apache/servicecomb-java-chassis/blob/master/client/service-center-client/src/main/java/org/apache/servicecomb/service/center/client/ServiceCenterClient.java)
+
+
+### More development
+
+- Support All Service-center HTTP API
+
+### Contact
+Bugs/Feature :
[issues](https://github.com/apache/servicecomb-java-chassis/issues)
