forked from loafle/openapi-generator-original

Benjamin Douglas 9058099e5b Add alias type definitions for Java

When a spec defines a Model at the top level that is a non-aggretate type (such
as string, number or boolean), it essentially represents an alias for the simple
type. For example, the following spec snippet creates an alias of the boolean
type that for all intents and purposes acts just like a regular boolean.

    definitions:
      JustABoolean:
        type: boolean

This can be modeled in some languages through built-in mechanisms, such as
typedefs in C++. Java, however, just not have a clean way of representing this.

This change introduces an internal mechanism for representing aliases. It
maintains a map in DefaultCodegen that tracks these types of definitions, and
wherever it sees the "JustABoolean" type in the spec, it generates code that
uses the built-in "Boolean" instead.

This functionality currenlty only applies to Java, but could be extended to
other languages later.

The change adds a few examples of this to the fake endpoint spec for testing,
which means all of the samples change as well.

2017-04-17 12:58:31 -07:00

12 KiB

Raw Blame History

FakeApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	HTTP request	Description
fakeOuterBooleanSerialize	POST /fake/outer/boolean
fakeOuterCompositeSerialize	POST /fake/outer/composite
fakeOuterNumberSerialize	POST /fake/outer/number
fakeOuterStringSerialize	POST /fake/outer/string
testClientModel	PATCH /fake	To test "client" model
testEndpointParameters	POST /fake	Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트
testEnumParameters	GET /fake	To test enum parameters

fakeOuterBooleanSerialize

Boolean fakeOuterBooleanSerialize(body)

Test serialization of outer boolean types

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FakeApi;


FakeApi apiInstance = new FakeApi();
Boolean body = true; // Boolean | Input boolean as post body
try {
    Boolean result = apiInstance.fakeOuterBooleanSerialize(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FakeApi#fakeOuterBooleanSerialize");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Boolean	Input boolean as post body	[optional]

Return type

Boolean

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

fakeOuterCompositeSerialize

OuterComposite fakeOuterCompositeSerialize(body)

Test serialization of object with outer number type

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FakeApi;


FakeApi apiInstance = new FakeApi();
OuterComposite body = new OuterComposite(); // OuterComposite | Input composite as post body
try {
    OuterComposite result = apiInstance.fakeOuterCompositeSerialize(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FakeApi#fakeOuterCompositeSerialize");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	OuterComposite	Input composite as post body	[optional]

Return type

OuterComposite

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

fakeOuterNumberSerialize

BigDecimal fakeOuterNumberSerialize(body)

Test serialization of outer number types

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FakeApi;


FakeApi apiInstance = new FakeApi();
BigDecimal body = new BigDecimal(); // BigDecimal | Input number as post body
try {
    BigDecimal result = apiInstance.fakeOuterNumberSerialize(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FakeApi#fakeOuterNumberSerialize");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	BigDecimal	Input number as post body	[optional]

Return type

BigDecimal

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

fakeOuterStringSerialize

String fakeOuterStringSerialize(body)

Test serialization of outer string types

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FakeApi;


FakeApi apiInstance = new FakeApi();
String body = "body_example"; // String | Input string as post body
try {
    String result = apiInstance.fakeOuterStringSerialize(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FakeApi#fakeOuterStringSerialize");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	String	Input string as post body	[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

testClientModel

Client testClientModel(body)

To test "client" model

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FakeApi;


FakeApi apiInstance = new FakeApi();
Client body = new Client(); // Client | client model
try {
    Client result = apiInstance.testClientModel(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FakeApi#testClientModel");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Client	client model

Return type

Client

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

testEndpointParameters

testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback)

Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.FakeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: http_basic_test
HttpBasicAuth http_basic_test = (HttpBasicAuth) defaultClient.getAuthentication("http_basic_test");
http_basic_test.setUsername("YOUR USERNAME");
http_basic_test.setPassword("YOUR PASSWORD");

FakeApi apiInstance = new FakeApi();
BigDecimal number = new BigDecimal(); // BigDecimal | None
Double _double = 3.4D; // Double | None
String patternWithoutDelimiter = "patternWithoutDelimiter_example"; // String | None
byte[] _byte = B; // byte[] | None
Integer integer = 56; // Integer | None
Integer int32 = 56; // Integer | None
Long int64 = 789L; // Long | None
Float _float = 3.4F; // Float | None
String string = "string_example"; // String | None
byte[] binary = B; // byte[] | None
LocalDate date = new LocalDate(); // LocalDate | None
OffsetDateTime dateTime = new OffsetDateTime(); // OffsetDateTime | None
String password = "password_example"; // String | None
String paramCallback = "paramCallback_example"; // String | None
try {
    apiInstance.testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback);
} catch (ApiException e) {
    System.err.println("Exception when calling FakeApi#testEndpointParameters");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
number	BigDecimal	None
_double	Double	None
patternWithoutDelimiter	String	None
_byte	byte[]	None
integer	Integer	None	[optional]
int32	Integer	None	[optional]
int64	Long	None	[optional]
_float	Float	None	[optional]
string	String	None	[optional]
binary	byte[]	None	[optional]
date	LocalDate	None	[optional]
dateTime	OffsetDateTime	None	[optional]
password	String	None	[optional]
paramCallback	String	None	[optional]

Return type

null (empty response body)

Authorization

http_basic_test

HTTP request headers

Content-Type: application/xml; charset=utf-8, application/json; charset=utf-8
Accept: application/xml; charset=utf-8, application/json; charset=utf-8

testEnumParameters

testEnumParameters(enumFormStringArray, enumFormString, enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble)

To test enum parameters

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FakeApi;


FakeApi apiInstance = new FakeApi();
List<String> enumFormStringArray = Arrays.asList("enumFormStringArray_example"); // List<String> | Form parameter enum test (string array)
String enumFormString = "-efg"; // String | Form parameter enum test (string)
List<String> enumHeaderStringArray = Arrays.asList("enumHeaderStringArray_example"); // List<String> | Header parameter enum test (string array)
String enumHeaderString = "-efg"; // String | Header parameter enum test (string)
List<String> enumQueryStringArray = Arrays.asList("enumQueryStringArray_example"); // List<String> | Query parameter enum test (string array)
String enumQueryString = "-efg"; // String | Query parameter enum test (string)
Integer enumQueryInteger = 56; // Integer | Query parameter enum test (double)
Double enumQueryDouble = 3.4D; // Double | Query parameter enum test (double)
try {
    apiInstance.testEnumParameters(enumFormStringArray, enumFormString, enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble);
} catch (ApiException e) {
    System.err.println("Exception when calling FakeApi#testEnumParameters");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
enumFormStringArray	List<String>	Form parameter enum test (string array)	[optional] [enum: >, $]
enumFormString	String	Form parameter enum test (string)	[optional] [default to -efg] [enum: _abc, -efg, (xyz)]
enumHeaderStringArray	List<String>	Header parameter enum test (string array)	[optional] [enum: >, $]
enumHeaderString	String	Header parameter enum test (string)	[optional] [default to -efg] [enum: _abc, -efg, (xyz)]
enumQueryStringArray	List<String>	Query parameter enum test (string array)	[optional] [enum: >, $]
enumQueryString	String	Query parameter enum test (string)	[optional] [default to -efg] [enum: _abc, -efg, (xyz)]
enumQueryInteger	Integer	Query parameter enum test (double)	[optional] [enum: 1, -2]
enumQueryDouble	Double	Query parameter enum test (double)	[optional] [enum: 1.1, -1.2]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: /

12 KiB Raw Blame History

FakeApi

fakeOuterBooleanSerialize

Example

Parameters

Return type

Authorization

HTTP request headers

fakeOuterCompositeSerialize

Example

Parameters

Return type

Authorization

HTTP request headers

fakeOuterNumberSerialize

Example

Parameters

Return type

Authorization

HTTP request headers

fakeOuterStringSerialize

Example

Parameters

Return type

Authorization

HTTP request headers

testClientModel

Example

Parameters

Return type

Authorization

HTTP request headers

testEndpointParameters

Example

Parameters

Return type

Authorization

HTTP request headers

testEnumParameters

Example

Parameters

Return type

Authorization

HTTP request headers

12 KiB

Raw Blame History