java-tutorials/spring-swagger-codegen/spring-openapi-generator-ap...
vunamtien 9ff1e00b0e
[JAVA-31658] Upgrade cactoos, jcabi-aspects, threetenbp, jodatime (#16293)
2024-04-05 10:49:54 +03:00
..
.openapi-generator BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
docs BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
gradle/wrapper BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
src [JAVA-31658] Upgrade cactoos, jcabi-aspects, threetenbp, jodatime (#16293) 2024-04-05 10:49:54 +03:00
.openapi-generator-ignore BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
.travis.yml BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
README.md BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
build.gradle [JAVA-31658] Upgrade cactoos, jcabi-aspects, threetenbp, jodatime (#16293) 2024-04-05 10:49:54 +03:00
build.sbt BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
git_push.sh BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
gradle.properties BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
gradlew BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
gradlew.bat BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00
pom.xml [JAVA-31658] Upgrade cactoos, jcabi-aspects, threetenbp, jodatime (#16293) 2024-04-05 10:49:54 +03:00
settings.gradle BAEL-3304 - spatialguru.net@gmail.com (#8883) 2020-03-22 19:06:39 +00:00

README.md

spring-openapi-generator-api-client

Swagger Petstore

  • API version: 1.0.3

  • Build date: 2020-03-15T06:14:01.568992-05:00[America/Chicago]

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  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.baeldung</groupId>
  <artifactId>spring-openapi-generator-api-client</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.baeldung:spring-openapi-generator-api-client:0.0.1-SNAPSHOT"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/spring-openapi-generator-api-client-0.0.1-SNAPSHOT.jar
  • target/lib/*.jar

Getting Started

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


import com.baeldung.petstore.client.invoker.*;
import com.baeldung.petstore.client.invoker.auth.*;
import com.baeldung.petstore.client.model.*;
import com.baeldung.petstore.client.api.PetApi;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://petstore.swagger.io/v2");
        
        // Configure OAuth2 access token for authorization: petstore_auth
        OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
        petstore_auth.setAccessToken("YOUR ACCESS TOKEN");

        PetApi apiInstance = new PetApi(defaultClient);
        Pet body = new Pet(); // Pet | Pet object that needs to be added to the store
        try {
            apiInstance.addPet(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#addPet");
            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 https://petstore.swagger.io/v2

Class Method HTTP request Description
PetApi addPet POST /pet Add a new pet to the store
PetApi deletePet DELETE /pet/{petId} Deletes a pet
PetApi findPetsByStatus GET /pet/findByStatus Finds Pets by status
PetApi findPetsByTags GET /pet/findByTags Finds Pets by tags
PetApi getPetById GET /pet/{petId} Find pet by ID
PetApi updatePet PUT /pet Update an existing pet
PetApi updatePetWithForm POST /pet/{petId} Updates a pet in the store with form data
PetApi uploadFile POST /pet/{petId}/uploadImage uploads an image
StoreApi deleteOrder DELETE /store/order/{orderId} Delete purchase order by ID
StoreApi getInventory GET /store/inventory Returns pet inventories by status
StoreApi getOrderById GET /store/order/{orderId} Find purchase order by ID
StoreApi placeOrder POST /store/order Place an order for a pet
UserApi createUser POST /user Create user
UserApi createUsersWithArrayInput POST /user/createWithArray Creates list of users with given input array
UserApi createUsersWithListInput POST /user/createWithList Creates list of users with given input array
UserApi deleteUser DELETE /user/{username} Delete user
UserApi getUserByName GET /user/{username} Get user by user name
UserApi loginUser GET /user/login Logs user into the system
UserApi logoutUser GET /user/logout Logs out current logged in user session
UserApi updateUser PUT /user/{username} Updated user

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

api_key

  • Type: API key
  • API key parameter name: api_key
  • Location: HTTP header

petstore_auth

Recommendation

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

Author

apiteam@swagger.io