Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaochun1211 committed Apr 19, 2021
1 parent d5b310b commit 9e53181
Show file tree
Hide file tree
Showing 12 changed files with 201 additions and 15 deletions.
41 changes: 26 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
# Taurus Java SDK

## 简介
这个SDK是对Taurus接口的一个封装, 只需要简单的配置, 就可以调用Taurus的接口,让你更快捷的接入Taurus.

### Taurus接口文档
接口文档: http://k8s-azure.silot.tech:40015/

## 安装
### Maven
<p align="center">
<a target="_blank" href="https://services.gradle.org/distributions/">
<img src="https://img.shields.io/badge/license-Apache 2-blue.svg" />
</a>
<a target="_blank" href="https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html">
<img src="https://img.shields.io/badge/JDK-8+-green.svg" />
</a>
<a target="_blank" href="https://services.gradle.org/distributions/">
<img src="https://img.shields.io/badge/Gradle-6.3-green.svg" />
</a>
</p>

## Introduction
This library is the abstraction of Taurus API for access from applications written with Java, which enable you to acces Taurus with quick and easy manner

### Taurus API Document
API Documentation: https://taurus-docs.silot.tech/

## Installation
### With Maven
```
<dependency>
<groupId>ai.silot.taurus</groupId>
Expand All @@ -19,13 +30,14 @@
```
implementation 'ai.silot.taurus:taurus-sdk-java:1.0.0'
```
### 非Maven项目
自行下载jar包
### Without Maven
Please download the jar package through the link below

https://repo1.maven.org/maven2/ai/silot/taurus/taurus-sdk-java/1.0.0/

## 使用
查看 [Taurus接口文档](http://k8s-azure.silot.tech:40015/), 拿到你的API Key以及对应环境的服务器域名.
## How to use
Check [Taurus API Document](https://taurus-docs.silot.tech/), Please obtain ```API Key``` and endpoints of correspoinding environment.

```java
public class Example {
public static void main(String[] args) {
Expand All @@ -44,5 +56,4 @@ public class Example {
}
}
```
更多示例请查看 [https://github.com/silotrd/taurus-sdk-java-example/tree/main/src/main/java/ai/silot/taurus/example](https://github.com/silotrd/taurus-sdk-java-example/tree/main/src/main/java/ai/silot/taurus/example)

For more examples, please check [https://github.com/silotrd/taurus-sdk-java/tree/main/src/test/java/ai/silot/taurus/service](https://github.com/silotrd/taurus-sdk-java/tree/main/src/test/java/ai/silot/taurus/service)
15 changes: 15 additions & 0 deletions src/main/java/ai/silot/taurus/config/Taurus.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ai.silot.taurus.config;

public class Taurus {
Expand Down
16 changes: 16 additions & 0 deletions src/main/java/ai/silot/taurus/model/TaurusBaseVo.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.model;

import lombok.Data;
Expand Down
16 changes: 16 additions & 0 deletions src/main/java/ai/silot/taurus/model/TaurusListVo.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.model;

import lombok.Data;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.model.disbursement;

import lombok.Data;
Expand Down
16 changes: 16 additions & 0 deletions src/main/java/ai/silot/taurus/service/DisbursementService.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.service;

import ai.silot.taurus.config.Taurus;
Expand Down
16 changes: 16 additions & 0 deletions src/main/java/ai/silot/taurus/service/InvoiceService.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.service;

import ai.silot.taurus.config.Taurus;
Expand Down
16 changes: 16 additions & 0 deletions src/main/java/ai/silot/taurus/util/Base64.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.util;

public class Base64 {
Expand Down
16 changes: 16 additions & 0 deletions src/main/java/ai/silot/taurus/util/HttpRequest.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.util;


Expand Down
16 changes: 16 additions & 0 deletions src/main/java/ai/silot/taurus/util/HttpResponse.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.util;

public class HttpResponse {
Expand Down
16 changes: 16 additions & 0 deletions src/main/java/ai/silot/taurus/util/Method.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.util;

public enum Method {
Expand Down
16 changes: 16 additions & 0 deletions src/main/java/ai/silot/taurus/util/TaurusHttpUtil.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
/*
* Copyright 2021 silot.ai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package ai.silot.taurus.util;

import ai.silot.taurus.config.Taurus;
Expand Down

0 comments on commit 9e53181

Please sign in to comment.