openapi-generator/samples/client/petstore/java/webclient-swagger2

petstore-webclient

OpenAPI Petstore

• API version: 1.0.0

• Generator version: 7.6.0-SNAPSHOT

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \

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

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

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/petstore-webclient-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.AnotherFakeApi;

public class AnotherFakeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://petstore.swagger.io:80/v2");
        
        AnotherFakeApi apiInstance = new AnotherFakeApi(defaultClient);
        Client client = new Client(); // Client | client model
        try {
            Client result = apiInstance.call123testSpecialTags(client);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnotherFakeApi#call123testSpecialTags");
            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:80/v2

Class	Method	HTTP request	Description
AnotherFakeApi	call123testSpecialTags	PATCH /another-fake/dummy	To test special tags
DefaultApi	fooGet	GET /foo
FakeApi	fakeBigDecimalMap	GET /fake/BigDecimalMap
FakeApi	fakeHealthGet	GET /fake/health	Health check endpoint
FakeApi	fakeHttpSignatureTest	GET /fake/http-signature-test	test http signature authentication
FakeApi	fakeOuterBooleanSerialize	POST /fake/outer/boolean
FakeApi	fakeOuterCompositeSerialize	POST /fake/outer/composite
FakeApi	fakeOuterNumberSerialize	POST /fake/outer/number
FakeApi	fakeOuterStringSerialize	POST /fake/outer/string
FakeApi	fakePropertyEnumIntegerSerialize	POST /fake/property/enum-int
FakeApi	testAdditionalPropertiesReference	POST /fake/additionalProperties-reference	test referenced additionalProperties
FakeApi	testBodyWithBinary	PUT /fake/body-with-binary
FakeApi	testBodyWithFileSchema	PUT /fake/body-with-file-schema
FakeApi	testBodyWithQueryParams	PUT /fake/body-with-query-params
FakeApi	testClientModel	PATCH /fake	To test "client" model
FakeApi	testEndpointParameters	POST /fake	Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
FakeApi	testEnumParameters	GET /fake	To test enum parameters
FakeApi	testGroupParameters	DELETE /fake	Fake endpoint to test group parameters (optional)
FakeApi	testInlineAdditionalProperties	POST /fake/inline-additionalProperties	test inline additionalProperties
FakeApi	testInlineFreeformAdditionalProperties	POST /fake/inline-freeform-additionalProperties	test inline free-form additionalProperties
FakeApi	testJsonFormData	GET /fake/jsonFormData	test json serialization of form data
FakeApi	testNullable	POST /fake/nullable	test nullable parent property
FakeApi	testQueryParameterCollectionFormat	PUT /fake/test-query-parameters
FakeApi	testStringMapReference	POST /fake/stringMap-reference	test referenced string map
FakeClassnameTags123Api	testClassname	PATCH /fake_classname_test	To test class name in snake case
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
PetApi	uploadFileWithRequiredFile	POST /fake/{petId}/uploadImageWithRequiredFile	uploads an image (required)
StoreApi	deleteOrder	DELETE /store/order/{order_id}	Delete purchase order by ID
StoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
StoreApi	getOrderById	GET /store/order/{order_id}	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

• AdditionalPropertiesClass
• AllOfWithSingleRef
• Animal
• ArrayOfArrayOfNumberOnly
• ArrayOfNumberOnly
• ArrayTest
• Capitalization
• Cat
• Category
• ChildWithNullable
• ClassModel
• Client
• DeprecatedObject
• Dog
• EnumArrays
• EnumClass
• EnumTest
• FakeBigDecimalMap200Response
• FileSchemaTestClass
• Foo
• FooGetDefaultResponse
• FormatTest
• HasOnlyReadOnly
• HealthCheckResult
• MapTest
• MixedPropertiesAndAdditionalPropertiesClass
• Model200Response
• ModelApiResponse
• ModelFile
• ModelList
• ModelReturn
• Name
• NullableClass
• NumberOnly
• ObjectWithDeprecatedFields
• Order
• OuterComposite
• OuterEnum
• OuterEnumDefaultValue
• OuterEnumInteger
• OuterEnumIntegerDefaultValue
• OuterObjectWithEnumProperty
• ParentWithNullable
• Pet
• ReadOnlyFirst
• SingleRefType
• SpecialModelName
• Tag
• TestInlineFreeformAdditionalPropertiesRequest
• User

Documentation for Authorization

Authentication schemes defined for the API:

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
  • write:pets: modify pets in your account
  • read:pets: read your pets

api_key

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

api_key_query

• Type: API key
• API key parameter name: api_key_query
• Location: URL query string

http_basic_test

• Type: HTTP basic authentication

bearer_test

• Type: HTTP Bearer Token authentication (JWT)

http_signature_test

• Type: HTTP signature authentication

Recommendation

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

Author