openapi-java-client

Simple emlpoyee contract tracker api

• API version: 1.0.0
  • Build date: 2023-03-24T09:34:46.789412-07:00[America/Los_Angeles]

This API allows management of client contracts and tracks history of employee contract assignments

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.boxboat</groupId>
  <artifactId>openapi-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'openapi-java-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'openapi-java-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.boxboat:openapi-java-client:1.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/openapi-java-client-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.boxboat.simpletracker.api.ApiClient;
import com.boxboat.simpletracker.api.ApiException;
import com.boxboat.simpletracker.api.Configuration;
import com.boxboat.simpletracker.api.models.*;
import com.boxboat.simpletracker.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    Integer clientId = 56; // Integer | Numeric ID of the client
    try {
      apiInstance.clientsClientIdDelete(clientId);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#clientsClientIdDelete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	clientsClientIdDelete	DELETE /clients/{clientId}	Delete a client by ID
DefaultApi	clientsClientIdGet	GET /clients/{clientId}	Get a client by ID
DefaultApi	clientsClientIdPut	PUT /clients/{clientId}	Update a client by ID
DefaultApi	clientsGet	GET /clients	Get all clients
DefaultApi	clientsPost	POST /clients	Create new client
DefaultApi	contractsContractIdDelete	DELETE /contracts/{contractId}	Delete a contract by ID
DefaultApi	contractsContractIdGet	GET /contracts/{contractId}	Get a contract by ID
DefaultApi	contractsContractIdPut	PUT /contracts/{contractId}	Update a contract by ID
DefaultApi	contractsGet	GET /contracts	Get all contracts
DefaultApi	contractsPost	POST /contracts	Create new contract
DefaultApi	employeesEmployeeIdDelete	DELETE /employees/{employeeId}	Delete an employee by ID
DefaultApi	employeesEmployeeIdGet	GET /employees/{employeeId}	Get an employee by ID
DefaultApi	employeesEmployeeIdPut	PUT /employees/{employeeId}	Update an employee by ID
DefaultApi	employeesGet	GET /employees	Get all employees
DefaultApi	employeesPost	POST /employees	Create new employee
DefaultApi	historyGet	GET /history	Get all history
DefaultApi	historyHistoryIdDelete	DELETE /history/{historyId}	Delete an employee contract assignment by ID
DefaultApi	historyHistoryIdGet	GET /history/{historyId}	Get an employee contract asignment by ID
DefaultApi	historyHistoryIdPut	PUT /history/{historyId}	Update an employee contract assignment by ID
DefaultApi	historyPost	POST /history	Create new employee contract assignment

Documentation for Models

• Client
• ClientsPostRequest
• Contract
• ContractPatch
• Employee
• EmployeesPostRequest
• History
• HistoryPatch

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author