openapi-generator-original/samples/client/echo_api/java/apache-httpclient/README.md

echo-api-apache-httpclient

Echo Server API

• API version: 0.1.0

Echo Server API

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>echo-api-apache-httpclient</artifactId>
  <version>0.1.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.openapitools:echo-api-apache-httpclient:0.1.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/echo-api-apache-httpclient-0.1.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.BodyApi;

public class BodyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:3000");
        
        BodyApi apiInstance = new BodyApi(defaultClient);
        Pet pet = new Pet(); // Pet | Pet object that needs to be added to the store
        try {
            Pet result = apiInstance.testEchoBodyPet(pet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BodyApi#testEchoBodyPet");
            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://localhost:3000

Class	Method	HTTP request	Description
BodyApi	testEchoBodyPet	POST /echo/body/Pet	Test body parameter(s)
BodyApi	testEchoBodyPetResponseString	POST /echo/body/Pet/response_string	Test empty response body
FormApi	testFormIntegerBooleanString	POST /form/integer/boolean/string	Test form parameter(s)
HeaderApi	testHeaderIntegerBooleanString	GET /header/integer/boolean/string	Test header parameter(s)
PathApi	testsPathStringPathStringIntegerPathInteger	GET /path/string/{path_string}/integer/{path_integer}	Test path parameter(s)
QueryApi	testQueryIntegerBooleanString	GET /query/integer/boolean/string	Test query parameter(s)
QueryApi	testQueryStyleDeepObjectExplodeTrueObject	GET /query/style_deepObject/explode_true/object	Test query parameter(s)
QueryApi	testQueryStyleDeepObjectExplodeTrueObjectAllOf	GET /query/style_deepObject/explode_true/object/allOf	Test query parameter(s)
QueryApi	testQueryStyleFormExplodeTrueArrayString	GET /query/style_form/explode_true/array_string	Test query parameter(s)
QueryApi	testQueryStyleFormExplodeTrueObject	GET /query/style_form/explode_true/object	Test query parameter(s)
QueryApi	testQueryStyleFormExplodeTrueObjectAllOf	GET /query/style_form/explode_true/object/allOf	Test query parameter(s)

Documentation for Models

• Bird
• Category
• DataQuery
• DataQueryAllOf
• DefaultValue
• Pet
• Query
• StringEnumRef
• Tag
• TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
• TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter

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

team@openapitools.org