Skip to content

Commit 1d02d16

Browse files
committed
API client demo upgrade
1 parent 8ebf8cf commit 1d02d16

File tree

3 files changed

+42
-24
lines changed

3 files changed

+42
-24
lines changed

README.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -52,36 +52,51 @@ After a successful build, add the generated artifact as a dependency in your Jav
5252
Easily fetch WooCommerce customer data:
5353

5454
```java
55+
package wtx.woocommerce;
56+
5557
import java.util.List;
56-
import wtx.woocommerce.api.client.*;
58+
59+
import wtx.woocommerce.api.client.CustomersApi;
5760
import wtx.woocommerce.api.client.invoker.ApiException;
5861
import wtx.woocommerce.api.client.model.Customer;
5962

60-
public class WooCommerceClientDemo {
63+
public class WooCommerceApiClientUsageDemo {
64+
65+
// TODO: Set your WooCommerce API base path!
66+
private static final String API_BASE_PATH = "https://your-woocommerce-shop.com/wp-json/wc/v3";
67+
private static final String API_USERNAME = "TODO_SET_API_USERNAME";
68+
private static final String API_PASSWORD = "TODO_SET_API_PASSWORD";
69+
6170
public static void main(String[] args) {
62-
System.out.println(">>> Starting WooCommerceClientDemo...");
6371

72+
System.out.println(">>> Start running the WooCommerceApiClientUsageDemo...");
73+
74+
// Use WooCommerceApiClient(true) if you need to log API communication messages.
6475
WooCommerceApiClient apiClient = new WooCommerceApiClient();
65-
apiClient.setBasePath("https://your-woocommerce-shop.com/wp-json/wc/v3");
66-
apiClient.setUsername("YOUR_API_USERNAME");
67-
apiClient.setPassword("YOUR_API_PASSWORD");
76+
77+
apiClient.setBasePath(API_BASE_PATH);
78+
apiClient.setUsername(API_USERNAME);
79+
apiClient.setPassword(API_PASSWORD);
6880

6981
CustomersApi customersApi = new CustomersApi(apiClient);
7082

7183
try {
84+
7285
List<Customer> customers = customersApi.listAllCustomers(
73-
null, null, null, null, null,
74-
null, null, null, null, null, null
75-
);
76-
customers.forEach(customer ->
77-
System.out.println("Customer: " + customer.getEmail())
86+
null, null, null, null, null, null, null, null, null, null, null
7887
);
88+
89+
// Example list of customer's emails:
90+
customers.forEach(customer -> System.out.println("Customer: " + customer.getEmail()));
91+
7992
} catch (ApiException e) {
80-
System.err.println("API Error: " + e.getMessage());
93+
System.err.println("Error occurred during API call: " + e);
8194
}
8295

83-
System.out.println("<<< WooCommerceClientDemo finished.");
96+
System.out.println("<<< The WooCommerceApiClientUsageDemo has been finished.");
97+
8498
}
99+
85100
}
86101
```
87102

@@ -92,4 +107,4 @@ public class WooCommerceClientDemo {
92107

93108
🚀 Happy coding! 😊
94109

95-
**Your WTX Labs Team** 🚀
110+
**Your WTX Labs Team** 🚀

src/main/java/wtx/woocommerce/WooCommerceApiClient.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,20 @@
33
import wtx.woocommerce.api.client.config.OkHttpClientConfig;
44
import wtx.woocommerce.api.client.config.GsonConfig;
55
import wtx.woocommerce.api.client.invoker.ApiClient;
6+
import wtx.woocommerce.api.client.invoker.JSON;
67

78
public class WooCommerceApiClient extends ApiClient {
89

910
// Default setup of the API Client to provide ignoring not recognized fields in the response.
1011
public WooCommerceApiClient() {
11-
getJSON().setGson(GsonConfig.createGson());
12+
JSON.setGson(GsonConfig.createGson());
1213
setUserAgent("WooCommerceApiClient (by wtx-labs)");
1314
}
1415

1516
// Default configuration improved with logging API communication messages.
1617
public WooCommerceApiClient(boolean enableLoggingApiMessages) {
1718

18-
getJSON().setGson(GsonConfig.createGson());
19+
JSON.setGson(GsonConfig.createGson());
1920
setUserAgent("WooCommerceApiClient (by wtx-labs)");
2021

2122
if (enableLoggingApiMessages) {

src/main/java/wtx/woocommerce/WooCommerceApiClientUsageDemo.java

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,30 @@
88

99
public class WooCommerceApiClientUsageDemo {
1010

11+
// TODO: Set your WooCommerce API base path!
12+
private static final String API_BASE_PATH = "https://your-woocommerce-shop.com/wp-json/wc/v3";
13+
private static final String API_USERNAME = "TODO_SET_API_USERNAME";
14+
private static final String API_PASSWORD = "TODO_SET_API_PASSWORD";
15+
1116
public static void main(String[] args) {
1217

1318
System.out.println(">>> Start running the WooCommerceApiClientUsageDemo...");
1419

1520
// Use WooCommerceApiClient(true) if you need to log API communication messages.
1621
WooCommerceApiClient apiClient = new WooCommerceApiClient();
1722

18-
// TODO: Set your host and credentials!
19-
apiClient.setBasePath("https://your-woocommerce-shop.com/wp-json/wc/v3");
20-
apiClient.setUsername("TODO_SET_API_USERNAME");
21-
apiClient.setPassword("TODO_SET_API_PASSWORD");
23+
apiClient.setBasePath(API_BASE_PATH);
24+
apiClient.setUsername(API_USERNAME);
25+
apiClient.setPassword(API_PASSWORD);
2226

2327
CustomersApi customersApi = new CustomersApi(apiClient);
2428

2529
try {
2630

2731
List<Customer> customers = customersApi.listAllCustomers(null, null, null, null, null, null, null, null, null, null, null);
2832

29-
// Example list of customer emails:
30-
for (Customer customer : customers) {
31-
System.out.println("Customer: " + customer.getEmail());
32-
}
33+
// Example list of customer's emails:
34+
customers.forEach(customer -> System.out.println("Customer: " + customer.getEmail()));
3335

3436
} catch (ApiException e) {
3537
System.err.println("Error occurred during API call: " + e);

0 commit comments

Comments
 (0)