[servicecomb-java-chassis] 01/02: [SCB-1574] Add README for Kie-Client

[li...@apache.org]

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

commit e58a2c0c89153bffb2e0deb03e26530d5d5d4303
Author: zhouzhongyuan <zh...@huawei.com>
AuthorDate: Sat Nov 9 16:51:41 2019 +0800

    [SCB-1574] Add README for Kie-Client
    
    To help users use the Kie-client more easily, add a README to the Kie-client.
---
 client/kie-client/README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

diff --git a/client/kie-client/README.md b/client/kie-client/README.md
new file mode 100644
index 0000000..f88f265
--- /dev/null
+++ b/client/kie-client/README.md
@@ -0,0 +1,80 @@
+## ServiceComb-Kie Client for Java
+
+   Sample Java client for ServiceComb-Kie HTTP OPENAPI. If you want more information about the ServiceComb-Kie, go [here](https://github.com/apache/servicecomb-kie).
+   
+### Build & Install
+   
+   local Build from source:
+   ```
+    maven clean install
+   ```
+   
+   add dependency to maven:
+   ```
+    <dependency>
+        <groupId>org.apache.servicecomb</groupId>
+        <artifactId>kie-client</artifactId>
+        <version>2.0.0-SNAPSHOT</version>
+    </dependency>
+   ```
+
+
+### Basic Usage
+
+#### Case 1: Create value of a key
+```
+KieClient kieClient = new KieClient();
+
+//state a KVBody Object
+KVBody kvBody = new KVBody();
+kvBody.setValue("testValue");
+Map<String, String> labels = new HashMap<>();
+labels.put("app", "111");
+kvBody.setLabels(labels);
+
+//create key-value
+kieClient1.putKeyValue("test",kvBody)  
+```
+
+#### Case 2: Get value of a key
+```
+KieClient kieClient = new KieClient();
+
+//get key-value by key
+List<KVResponse> kvResponses = kieClient.getValueOfKey("test");
+```
+
+#### Case 3: Search key-value by lables
+```
+KieClient kieClient = new KieClient();
+
+//state a Map<String,String> as labels
+Map<String, String> labels = new HashMap<>();
+labels.put("app", "111");
+
+//get key-value by labels
+List<KVResponse> searchKVResponses = kieClient.searchKeyValueByLabels(labels);
+```
+
+#### Case 4: Delete key-value
+```
+KieClient kieClient = new KieClient(kieRawClient);
+
+//get key-value by key
+List<KVResponse> kvResponses = kieClient.getValueOfKey("test");
+
+//delete all key-value of key
+for(KVResponse kvResponse : kvResponses){
+  for (KVDoc kvDoc : kvResponse.getData()){
+    kieClient.deleteKeyValue(kvDoc);
+  }
+}
+```
+
+### More development
+
+- Support for SSL authentication
+- Implement dynamic config
+
+### Contact
+Bugs/Feature : [issues](https://github.com/apache/servicecomb-java-chassis/issues)