Building the API client library requires:
- Java 1.8 or higher Installation
- Gradle Installation
⚠️ Make sure that Gradle version is compatible with Java See in docs.
⚠️ If you also have JRE installed, create a new environment variable for Java and set a new path for the PATH environment to the JDK folder in "Program Files". Guides for creating and setting a new path: Windows / Unix / MacOS.
To copy the API client to your computer copy link of the repository, open Command Prompt, go to the location where project will be copied and execute git clone command:
git clone https://github.com/kyriba/dev-portal-Filtering-Sorting-Paginating-sample.gitOpen the project folder via command prompt, for example:
cd dev-portal-Filtering-Sorting-Paginating-sample
⚠️ Before building project go to .../src/main/resources/application.yml and update client_id and client_secret with your credentials.
Build project:
gradle clean buildAnd execute jar file:
java -jar "build/libs/filtering-sorting-pagination-1.0.0.jar"
⚠️ Please notice that the path to your local directory is provided in MacOS/Unix format. Windows is slash-sensitive, so if you are using a Windows system, replace "/" with "\".
Choose the API from the provided list in the Terminal, by typing the number of the item on the list or by providing the name of the API. Name are case-sensitive, make sure you write them in lower-case and not introduce any additional characters.
Go to the link:
http://localhost:5000/list
⚠️ To change the port, go to .../src/main/resources/application.yml and replace the "port" value.
If everything was done accordingly with provided steps, the result should look as presented in the image below:
To terminate application press Ctrl + C and execute Y.
Note that new APIs, filters and values for them can be added to the application.yml file.
⚠️ If application.yml was modified after application had been built, it needs to be rebuilt. In that case, execute gradle clean build again.