echo-api-native
Echo Server API
- 
API version: 0.1.0
 - 
Generator version: 7.5.0-SNAPSHOT
 
Echo Server API
Automatically generated by the OpenAPI Generator
Requirements
Building the API client library requires:
- Java 11+
 - 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-native</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-native:0.1.0"
Others
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/echo-api-native-0.1.0.jartarget/lib/*.jar
Getting Started
Please follow the installation instruction and execute the following Java code:
import org.openapitools.client.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthApi;
public class AuthApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure clients using the `defaultClient` object, such as
        // overriding the host and port, timeout, etc.
        AuthApi apiInstance = new AuthApi(defaultClient);
        try {
            String result = apiInstance.testAuthHttpBasic();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#testAuthHttpBasic");
            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 | 
|---|---|---|---|
| AuthApi | testAuthHttpBasic | POST /auth/http/basic | To test HTTP basic authentication | 
| AuthApi | testAuthHttpBasicWithHttpInfo | POST /auth/http/basic | To test HTTP basic authentication | 
| AuthApi | testAuthHttpBearer | POST /auth/http/bearer | To test HTTP bearer authentication | 
| AuthApi | testAuthHttpBearerWithHttpInfo | POST /auth/http/bearer | To test HTTP bearer authentication | 
| BodyApi | testBinaryGif | POST /binary/gif | Test binary (gif) response body | 
| BodyApi | testBinaryGifWithHttpInfo | POST /binary/gif | Test binary (gif) response body | 
| BodyApi | testBodyApplicationOctetstreamBinary | POST /body/application/octetstream/binary | Test body parameter(s) | 
| BodyApi | testBodyApplicationOctetstreamBinaryWithHttpInfo | POST /body/application/octetstream/binary | Test body parameter(s) | 
| BodyApi | testBodyMultipartFormdataArrayOfBinary | POST /body/application/octetstream/array_of_binary | Test array of binary in multipart mime | 
| BodyApi | testBodyMultipartFormdataArrayOfBinaryWithHttpInfo | POST /body/application/octetstream/array_of_binary | Test array of binary in multipart mime | 
| BodyApi | testBodyMultipartFormdataSingleBinary | POST /body/application/octetstream/single_binary | Test single binary in multipart mime | 
| BodyApi | testBodyMultipartFormdataSingleBinaryWithHttpInfo | POST /body/application/octetstream/single_binary | Test single binary in multipart mime | 
| BodyApi | testEchoBodyAllOfPet | POST /echo/body/allOf/Pet | Test body parameter(s) | 
| BodyApi | testEchoBodyAllOfPetWithHttpInfo | POST /echo/body/allOf/Pet | Test body parameter(s) | 
| BodyApi | testEchoBodyFreeFormObjectResponseString | POST /echo/body/FreeFormObject/response_string | Test free form object | 
| BodyApi | testEchoBodyFreeFormObjectResponseStringWithHttpInfo | POST /echo/body/FreeFormObject/response_string | Test free form object | 
| BodyApi | testEchoBodyPet | POST /echo/body/Pet | Test body parameter(s) | 
| BodyApi | testEchoBodyPetWithHttpInfo | POST /echo/body/Pet | Test body parameter(s) | 
| BodyApi | testEchoBodyPetResponseString | POST /echo/body/Pet/response_string | Test empty response body | 
| BodyApi | testEchoBodyPetResponseStringWithHttpInfo | POST /echo/body/Pet/response_string | Test empty response body | 
| BodyApi | testEchoBodyStringEnum | POST /echo/body/string_enum | Test string enum response body | 
| BodyApi | testEchoBodyStringEnumWithHttpInfo | POST /echo/body/string_enum | Test string enum response body | 
| BodyApi | testEchoBodyTagResponseString | POST /echo/body/Tag/response_string | Test empty json (request body) | 
| BodyApi | testEchoBodyTagResponseStringWithHttpInfo | POST /echo/body/Tag/response_string | Test empty json (request body) | 
| FormApi | testFormIntegerBooleanString | POST /form/integer/boolean/string | Test form parameter(s) | 
| FormApi | testFormIntegerBooleanStringWithHttpInfo | POST /form/integer/boolean/string | Test form parameter(s) | 
| FormApi | testFormObjectMultipart | POST /form/object/multipart | Test form parameter(s) for multipart schema | 
| FormApi | testFormObjectMultipartWithHttpInfo | POST /form/object/multipart | Test form parameter(s) for multipart schema | 
| FormApi | testFormOneof | POST /form/oneof | Test form parameter(s) for oneOf schema | 
| FormApi | testFormOneofWithHttpInfo | POST /form/oneof | Test form parameter(s) for oneOf schema | 
| HeaderApi | testHeaderIntegerBooleanStringEnums | GET /header/integer/boolean/string/enums | Test header parameter(s) | 
| HeaderApi | testHeaderIntegerBooleanStringEnumsWithHttpInfo | GET /header/integer/boolean/string/enums | Test header parameter(s) | 
| PathApi | testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath | GET /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path} | Test path parameter(s) | 
| PathApi | testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPathWithHttpInfo | GET /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path} | Test path parameter(s) | 
| QueryApi | testEnumRefString | GET /query/enum_ref_string | Test query parameter(s) | 
| QueryApi | testEnumRefStringWithHttpInfo | GET /query/enum_ref_string | Test query parameter(s) | 
| QueryApi | testQueryDatetimeDateString | GET /query/datetime/date/string | Test query parameter(s) | 
| QueryApi | testQueryDatetimeDateStringWithHttpInfo | GET /query/datetime/date/string | Test query parameter(s) | 
| QueryApi | testQueryIntegerBooleanString | GET /query/integer/boolean/string | Test query parameter(s) | 
| QueryApi | testQueryIntegerBooleanStringWithHttpInfo | GET /query/integer/boolean/string | Test query parameter(s) | 
| QueryApi | testQueryStyleDeepObjectExplodeTrueObject | GET /query/style_deepObject/explode_true/object | Test query parameter(s) | 
| QueryApi | testQueryStyleDeepObjectExplodeTrueObjectWithHttpInfo | 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 | testQueryStyleDeepObjectExplodeTrueObjectAllOfWithHttpInfo | GET /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) | 
| QueryApi | testQueryStyleFormExplodeFalseArrayInteger | GET /query/style_form/explode_false/array_integer | Test query parameter(s) | 
| QueryApi | testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo | GET /query/style_form/explode_false/array_integer | Test query parameter(s) | 
| QueryApi | testQueryStyleFormExplodeFalseArrayString | GET /query/style_form/explode_false/array_string | Test query parameter(s) | 
| QueryApi | testQueryStyleFormExplodeFalseArrayStringWithHttpInfo | GET /query/style_form/explode_false/array_string | Test query parameter(s) | 
| QueryApi | testQueryStyleFormExplodeTrueArrayString | GET /query/style_form/explode_true/array_string | Test query parameter(s) | 
| QueryApi | testQueryStyleFormExplodeTrueArrayStringWithHttpInfo | 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 | testQueryStyleFormExplodeTrueObjectWithHttpInfo | 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) | 
| QueryApi | testQueryStyleFormExplodeTrueObjectAllOfWithHttpInfo | GET /query/style_form/explode_true/object/allOf | Test query parameter(s) | 
Documentation for Models
- Bird
 - Category
 - DataQuery
 - DefaultValue
 - NumberPropertiesOnly
 - Pet
 - Query
 - StringEnumRef
 - Tag
 - TestFormObjectMultipartRequestMarker
 - TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
 - TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
 
Documentation for Authorization
Authentication schemes defined for the API:
http_auth
- Type: HTTP basic authentication
 
http_bearer_auth
- Type: HTTP Bearer Token authentication
 
Recommendation
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.
However, the instances of the api clients created from the ApiClient are thread-safe and can be re-used.