Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apimatic/calculator-sdk
This repo is published on maven central. This is a simple calculator SDK generated through APIMatic (https://www.apimatic.io) that deals with auto generated Rest API client SDKs along with proper test coverage and documentation.
https://github.com/apimatic/calculator-sdk
Last synced: 15 days ago
JSON representation
This repo is published on maven central. This is a simple calculator SDK generated through APIMatic (https://www.apimatic.io) that deals with auto generated Rest API client SDKs along with proper test coverage and documentation.
- Host: GitHub
- URL: https://github.com/apimatic/calculator-sdk
- Owner: apimatic
- License: other
- Created: 2022-02-28T05:33:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-30T18:49:04.000Z (about 2 years ago)
- Last Synced: 2024-04-29T17:49:34.126Z (7 months ago)
- Language: Java
- Size: 60.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Getting Started with APIMATIC Calculator
## Introduction
Simple calculator API hosted on APIMATIC
## Building
The generated code uses a few Maven dependencies e.g., Jackson, OkHttp,
and Apache HttpClient. The reference to these dependencies is already
added in the pom.xml file will be installed automatically. Therefore,
you will need internet access for a successful build.
* In order to open the client library in Eclipse click on `File -> Import`.
* In the import dialog, select `Existing Java Project` and click `Next`.
* Browse to locate the folder containing the source code. Select the detected location of the project and click `Finish`.
* Upon successful import, the project will be automatically built by Eclipse after automatically resolving the dependencies.
## Installation
The following section explains how to use the APIMATICCalculatorLib library in a new project.
### 1. Starting a new project
For starting a new project, click the menu command `File > New > Project`.
Next, choose `Maven > Maven Project` and click `Next`.
Here, make sure to use the current workspace by choosing `Use default Workspace location`, as shown in the picture below and click `Next`.
Following this, select the *quick start* project type to create a simple project with an existing class and a `main` method. To do this, choose `maven-archetype-quickstart` item from the list and click `Next`.
In the last step, provide a `Group Id` and `Artifact Id` as shown in the picture below and click `Finish`.
### 2. Add reference of the library project
The created Maven project manages its dependencies using its `pom.xml` file. In order to add a dependency on the *APIMATICCalculatorLib* client library, double click on the `pom.xml` file in the `Package Explorer`. Opening the `pom.xml` file will render a graphical view on the canvas. Here, switch to the `Dependencies` tab and click the `Add` button as shown in the picture below.
Clicking the `Add` button will open a dialog where you need to specify APIMATICCalculatorLib in `Group Id`, apimaticcalculator-lib in `Artifact Id` and 1.0.0 in the `Version` fields. Once added click `OK`. Save the `pom.xml` file.
### 3. Write sample code
Once the `SimpleConsoleApp` is created, a file named `App.java` will be visible in the *Package Explorer* with a `main` method. This is the entry point for the execution of the created project.
Here, you can add code to initialize the client library and instantiate a *Controller* class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.
## Test the SDK
The generated code and the server can be tested using automatically generated test cases.
JUnit is used as the testing framework and test runner.
In Eclipse, for running the tests do the following:
1. Select the project APIMATICCalculatorLib from the package explorer.
2. Select `Run -> Run as -> JUnit Test` or use `Alt + Shift + X` followed by `T` to run the Tests.
## Initialize the API Client
**_Note:_** Documentation for the client can be found [here.](/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `environment` | Environment | The API environment.
**Default: `Environment.PRODUCTION`** |
| `httpClientConfig` | `ReadonlyHttpClientConfiguration` | Http Client Configuration instance.
* See available [builder methods here](/doc/http-client-configuration-builder.md). |
The API client can be initialized as follows:
```java
APIMATICCalculatorClient client = new APIMATICCalculatorClient.Builder()
.httpClientConfig(configBuilder -> configBuilder
.timeout(0))
.environment(Environment.PRODUCTION)
.build();
```
## List of APIs
* [Simple Calculator](/doc/controllers/simple-calculator.md)
## Classes Documentation
* [Utility Classes](/doc/utility-classes.md)
* [HttpRequest](/doc/http-request.md)
* [HttpResponse](/doc/http-response.md)
* [HttpStringResponse](/doc/http-string-response.md)
* [HttpContext](/doc/http-context.md)
* [HttpBodyRequest](/doc/http-body-request.md)
* [HttpCallback Interface](/doc/http-callback-interface.md)
* [Headers](/doc/headers.md)
* [ApiException](/doc/api-exception.md)
* [Configuration Interface](/doc/configuration-interface.md)
* [HttpClientConfiguration](/doc/http-client-configuration.md)
* [HttpClientConfiguration.Builder](/doc/http-client-configuration-builder.md)