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

15 KiB

Raw Blame History

IO.Swagger.Api.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

OuterBoolean FakeOuterBooleanSerialize (OuterBoolean body = null)

Test serialization of outer boolean types

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class FakeOuterBooleanSerializeExample
    {
        public void main()
        {
            
            var apiInstance = new FakeApi();
            var body = new OuterBoolean(); // OuterBoolean | Input boolean as post body (optional) 

            try
            {
                OuterBoolean result = apiInstance.FakeOuterBooleanSerialize(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FakeApi.FakeOuterBooleanSerialize: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

OuterBoolean

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FakeOuterCompositeSerialize

OuterComposite FakeOuterCompositeSerialize (OuterComposite body = null)

Test serialization of object with outer number type

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class FakeOuterCompositeSerializeExample
    {
        public void main()
        {
            
            var apiInstance = new FakeApi();
            var body = new OuterComposite(); // OuterComposite | Input composite as post body (optional) 

            try
            {
                OuterComposite result = apiInstance.FakeOuterCompositeSerialize(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FakeApi.FakeOuterCompositeSerialize: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FakeOuterNumberSerialize

OuterNumber FakeOuterNumberSerialize (OuterNumber body = null)

Test serialization of outer number types

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class FakeOuterNumberSerializeExample
    {
        public void main()
        {
            
            var apiInstance = new FakeApi();
            var body = new OuterNumber(); // OuterNumber | Input number as post body (optional) 

            try
            {
                OuterNumber result = apiInstance.FakeOuterNumberSerialize(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FakeApi.FakeOuterNumberSerialize: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

OuterNumber

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FakeOuterStringSerialize

OuterString FakeOuterStringSerialize (OuterString body = null)

Test serialization of outer string types

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class FakeOuterStringSerializeExample
    {
        public void main()
        {
            
            var apiInstance = new FakeApi();
            var body = new OuterString(); // OuterString | Input string as post body (optional) 

            try
            {
                OuterString result = apiInstance.FakeOuterStringSerialize(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FakeApi.FakeOuterStringSerialize: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

OuterString

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestClientModel

ModelClient TestClientModel (ModelClient body)

To test "client" model

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class TestClientModelExample
    {
        public void main()
        {
            
            var apiInstance = new FakeApi();
            var body = new ModelClient(); // ModelClient | client model

            try
            {
                // To test \"client\" model
                ModelClient result = apiInstance.TestClientModel(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FakeApi.TestClientModel: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
body	ModelClient	client model

Return type

ModelClient

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestEndpointParameters

void TestEndpointParameters (decimal? number, double? _double, string patternWithoutDelimiter, byte[] _byte, int? integer = null, int? int32 = null, long? int64 = null, float? _float = null, string _string = null, byte[] binary = null, DateTime? date = null, DateTime? dateTime = null, string password = null, string callback = null)

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

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class TestEndpointParametersExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: http_basic_test
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new FakeApi();
            var number = 3.4;  // decimal? | None
            var _double = 1.2;  // double? | None
            var patternWithoutDelimiter = patternWithoutDelimiter_example;  // string | None
            var _byte = B;  // byte[] | None
            var integer = 56;  // int? | None (optional) 
            var int32 = 56;  // int? | None (optional) 
            var int64 = 789;  // long? | None (optional) 
            var _float = 3.4;  // float? | None (optional) 
            var _string = _string_example;  // string | None (optional) 
            var binary = B;  // byte[] | None (optional) 
            var date = 2013-10-20;  // DateTime? | None (optional) 
            var dateTime = 2013-10-20T19:20:30+01:00;  // DateTime? | None (optional) 
            var password = password_example;  // string | None (optional) 
            var callback = callback_example;  // string | None (optional) 

            try
            {
                // Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
                apiInstance.TestEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, _string, binary, date, dateTime, password, callback);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FakeApi.TestEndpointParameters: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
number	decimal?	None
_double	double?	None
patternWithoutDelimiter	string	None
_byte	byte[]	None
integer	int?	None	[optional]
int32	int?	None	[optional]
int64	long?	None	[optional]
_float	float?	None	[optional]
_string	string	None	[optional]
binary	byte[]	None	[optional]
date	DateTime?	None	[optional]
dateTime	DateTime?	None	[optional]
password	string	None	[optional]
callback	string	None	[optional]

Return type

void (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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestEnumParameters

void TestEnumParameters (List enumFormStringArray = null, string enumFormString = null, List enumHeaderStringArray = null, string enumHeaderString = null, List enumQueryStringArray = null, string enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null)

To test enum parameters

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class TestEnumParametersExample
    {
        public void main()
        {
            
            var apiInstance = new FakeApi();
            var enumFormStringArray = new List<string>(); // List<string> | Form parameter enum test (string array) (optional) 
            var enumFormString = enumFormString_example;  // string | Form parameter enum test (string) (optional)  (default to -efg)
            var enumHeaderStringArray = new List<string>(); // List<string> | Header parameter enum test (string array) (optional) 
            var enumHeaderString = enumHeaderString_example;  // string | Header parameter enum test (string) (optional)  (default to -efg)
            var enumQueryStringArray = new List<string>(); // List<string> | Query parameter enum test (string array) (optional) 
            var enumQueryString = enumQueryString_example;  // string | Query parameter enum test (string) (optional)  (default to -efg)
            var enumQueryInteger = 56;  // int? | Query parameter enum test (double) (optional) 
            var enumQueryDouble = 1.2;  // double? | Query parameter enum test (double) (optional) 

            try
            {
                // To test enum parameters
                apiInstance.TestEnumParameters(enumFormStringArray, enumFormString, enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FakeApi.TestEnumParameters: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
enumFormStringArray	List<string>	Form parameter enum test (string array)	[optional]
enumFormString	string	Form parameter enum test (string)	[optional] [default to -efg]
enumHeaderStringArray	List<string>	Header parameter enum test (string array)	[optional]
enumHeaderString	string	Header parameter enum test (string)	[optional] [default to -efg]
enumQueryStringArray	List<string>	Query parameter enum test (string array)	[optional]
enumQueryString	string	Query parameter enum test (string)	[optional] [default to -efg]
enumQueryInteger	int?	Query parameter enum test (double)	[optional]
enumQueryDouble	double?	Query parameter enum test (double)	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

15 KiB Raw Blame History

IO.Swagger.Api.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

15 KiB

Raw Blame History