Skip to content

README.md

Latest commit

 

History

History
140 lines (89 loc) · 3.28 KB

README.md

File metadata and controls

140 lines (89 loc) · 3.28 KB

petstore-restclient

jspecify

  • API version: 1.0.0

  • Generator version: 7.23.0-SNAPSHOT

test fully qualified name and jspecify

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 17+
  2. Maven/Gradle

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>org.openapitools</groupId>
  <artifactId>petstore-restclient</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 'petstore-restclient' jar has been published to maven central.
    mavenLocal()       // Needed if the 'petstore-restclient' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "org.openapitools:petstore-restclient:1.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/petstore-restclient-1.0.0.jar
  • target/lib/*.jar

Getting Started

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

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = new ApiClient();
        defaultClient.setBasePath("http://localhost");
        
        DefaultApi apiInstance = new DefaultApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            apiInstance.fileIdGet(id);
        } catch (HttpStatusCodeException e) {
            System.err.println("Exception when calling DefaultApi#fileIdGet");
            System.err.println("Status code: " + e.getStatusCode().value());
            System.err.println("Reason: " + e.getResponseBodyAsString());
            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 fileIdGet GET /file/{id}
DefaultApi fooDtParamGet GET /foo/{dtParam}
DefaultApi uploadPost POST /upload

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

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

Author