CRUD

Requirements

Building the API client library requires:

1. JDK 1.8 or higher - Installation
2. 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

Installation

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-CRUD-sample.git

⚠️ Before building project go to .../src/main/resources/application.yml and update client.id and client.secret with your credentials.

Then open command prompt and go to your project directory, for example:

cd dev-portal-CRUD-sample

Build project:

gradle clean build

And execute jar file:

java -jar "build/libs/CRUD.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. Names are case-sensitive, make sure you write them in lower-case.

If the application runs successfully, you can go to the link:

http://localhost:2000/CRUD

If you want to change the port, go to .../src/main/resources/application.yml and replace the server.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.

If you want to add new API, go to .../src/main/resources/application.yml, add REST Endpoint of API to list.apis, add at least all mandatory fields to api.fields.{endpoint}*.

⚠️ {endpoint}* - REST Endpoint of API from list.apis

Then add all available CRUD methods of API to api.methods.{endpoint} and if there are any enums or boolean values, then add them to enums.available.values.{endpoint}.{field} **.

⚠️ {field} ** - the name of a specific field from api.fields.{endpoint}

⚠️ If application.yml was modified after application had been built, it needs to be rebuilt. In that case, execute gradle clean build again.