Skip to content

Latest commit

 

History

History

README.md

sdk-java

Swagger Petstore

  • API version: 1.0.0
    • Build date: 2020-05-04T11:53:27.525+10:00[Australia/Melbourne]

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.7+
  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>com.openapigenerator.sample</groupId>
  <artifactId>sdk-java</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.openapigenerator.sample:sdk-java:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/sdk-java-1.0.0.jar
  • target/lib/*.jar

Getting Started

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

// Import classes:
import com.openapigenerator.sample.client.ApiClient;
import com.openapigenerator.sample.client.ApiException;
import com.openapigenerator.sample.client.Configuration;
import com.openapigenerator.sample.client.models.*;
import com.openapigenerator.sample.api.PetsApi;

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

    PetsApi apiInstance = new PetsApi(defaultClient);
    try {
      apiInstance.createPets();
    } catch (ApiException e) {
      System.err.println("Exception when calling PetsApi#createPets");
      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://petstore.swagger.io/v1

Class Method HTTP request Description
PetsApi createPets POST /pets Create a pet
PetsApi listPets GET /pets List all pets
PetsApi showPetById GET /pets/{petId} Info for a specific pet

Documentation for Models

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