java-tutorials/spring-swagger-codegen/spring-swagger-codegen-api-...
Sanjay Patel cddf858c05 BAEL-5246: pom cleanup (#4620)
* BAEL-5246: round 1 of pom cleanup - upto "jersey" project

* BAEL-5246: Initial pass for pom cleanup - upto spring-cloud

* BAEL-5246: pom cleanup upto testing-modules/junit5

* BAEL-5246: pom cleanup - upto xstream

* BAEL-5246: pom cleanup - last round (before review)
2018-07-12 09:04:54 +02:00
..
.swagger-codegen BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
docs BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
gradle/wrapper BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
src Bael 6556 3 (#4382) 2018-06-01 13:12:51 +02:00
.gitignore BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
.swagger-codegen-ignore BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
.travis.yml BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
README.md BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
build.gradle BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
build.sbt BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
git_push.sh BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
gradle.properties BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
gradlew BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
gradlew.bat BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00
pom.xml BAEL-5246: pom cleanup (#4620) 2018-07-12 09:04:54 +02:00
settings.gradle BAEL-1116 Spring swagger codegen (#2527) 2017-09-04 05:41:49 +02:00

README.md

spring-swagger-codegen-api-client

Requirements

Building the API client library requires Maven to be installed.

Installation

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

mvn install

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

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>com.baeldung</groupId>
    <artifactId>spring-swagger-codegen-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-swagger-codegen-api-client:0.0.1-SNAPSHOT"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/spring-swagger-codegen-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;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // 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();
        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");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://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