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

10 KiB

Raw Blame History

Petstore::FakeApi

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

Method	HTTP request	Description
fake_outer_boolean_serialize	POST /fake/outer/boolean
fake_outer_composite_serialize	POST /fake/outer/composite
fake_outer_number_serialize	POST /fake/outer/number
fake_outer_string_serialize	POST /fake/outer/string
test_client_model	PATCH /fake	To test "client" model
test_endpoint_parameters	POST /fake	Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트
test_enum_parameters	GET /fake	To test enum parameters

fake_outer_boolean_serialize

OuterBoolean fake_outer_boolean_serialize(opts)

Test serialization of outer boolean types

Example

# load the gem
require 'petstore'

api_instance = Petstore::FakeApi.new

opts = { 
  body: Petstore::OuterBoolean.new # OuterBoolean | Input boolean as post body
}

begin
  result = api_instance.fake_outer_boolean_serialize(opts)
  p result
rescue Petstore::ApiError => e
  puts "Exception when calling FakeApi->fake_outer_boolean_serialize: #{e}"
end

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

fake_outer_composite_serialize

OuterComposite fake_outer_composite_serialize(opts)

Test serialization of object with outer number type

Example

# load the gem
require 'petstore'

api_instance = Petstore::FakeApi.new

opts = { 
  body: Petstore::OuterComposite.new # OuterComposite | Input composite as post body
}

begin
  result = api_instance.fake_outer_composite_serialize(opts)
  p result
rescue Petstore::ApiError => e
  puts "Exception when calling FakeApi->fake_outer_composite_serialize: #{e}"
end

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

fake_outer_number_serialize

OuterNumber fake_outer_number_serialize(opts)

Test serialization of outer number types

Example

# load the gem
require 'petstore'

api_instance = Petstore::FakeApi.new

opts = { 
  body: Petstore::OuterNumber.new # OuterNumber | Input number as post body
}

begin
  result = api_instance.fake_outer_number_serialize(opts)
  p result
rescue Petstore::ApiError => e
  puts "Exception when calling FakeApi->fake_outer_number_serialize: #{e}"
end

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

fake_outer_string_serialize

OuterString fake_outer_string_serialize(opts)

Test serialization of outer string types

Example

# load the gem
require 'petstore'

api_instance = Petstore::FakeApi.new

opts = { 
  body: Petstore::OuterString.new # OuterString | Input string as post body
}

begin
  result = api_instance.fake_outer_string_serialize(opts)
  p result
rescue Petstore::ApiError => e
  puts "Exception when calling FakeApi->fake_outer_string_serialize: #{e}"
end

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

test_client_model

Client test_client_model(body)

To test "client" model

Example

# load the gem
require 'petstore'

api_instance = Petstore::FakeApi.new

body = Petstore::Client.new # Client | client model


begin
  #To test \"client\" model
  result = api_instance.test_client_model(body)
  p result
rescue Petstore::ApiError => e
  puts "Exception when calling FakeApi->test_client_model: #{e}"
end

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

test_endpoint_parameters

test_endpoint_parameters(number, double, pattern_without_delimiter, byte, opts)

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

Example

# load the gem
require 'petstore'
# setup authorization
Petstore.configure do |config|
  # Configure HTTP basic authorization: http_basic_test
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Petstore::FakeApi.new

number = 3.4 # Float | None

double = 1.2 # Float | None

pattern_without_delimiter = "pattern_without_delimiter_example" # String | None

byte = "B" # String | None

opts = { 
  integer: 56, # Integer | None
  int32: 56, # Integer | None
  int64: 789, # Integer | None
  float: 3.4, # Float | None
  string: "string_example", # String | None
  binary: "B", # String | None
  date: Date.parse("2013-10-20"), # Date | None
  date_time: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | None
  password: "password_example", # String | None
  callback: "callback_example" # String | None
}

begin
  #Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
  api_instance.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, opts)
rescue Petstore::ApiError => e
  puts "Exception when calling FakeApi->test_endpoint_parameters: #{e}"
end

Parameters

Name	Type	Description	Notes
number	Float	None
double	Float	None
pattern_without_delimiter	String	None
byte	String	None
integer	Integer	None	[optional]
int32	Integer	None	[optional]
int64	Integer	None	[optional]
float	Float	None	[optional]
string	String	None	[optional]
binary	String	None	[optional]
date	Date	None	[optional]
date_time	DateTime	None	[optional]
password	String	None	[optional]
callback	String	None	[optional]

Return type

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

test_enum_parameters

test_enum_parameters(opts)

To test enum parameters

Example

# load the gem
require 'petstore'

api_instance = Petstore::FakeApi.new

opts = { 
  enum_form_string_array: ["enum_form_string_array_example"], # Array<String> | Form parameter enum test (string array)
  enum_form_string: "-efg", # String | Form parameter enum test (string)
  enum_header_string_array: ["enum_header_string_array_example"], # Array<String> | Header parameter enum test (string array)
  enum_header_string: "-efg", # String | Header parameter enum test (string)
  enum_query_string_array: ["enum_query_string_array_example"], # Array<String> | Query parameter enum test (string array)
  enum_query_string: "-efg", # String | Query parameter enum test (string)
  enum_query_integer: 56, # Integer | Query parameter enum test (double)
  enum_query_double: 1.2 # Float | Query parameter enum test (double)
}

begin
  #To test enum parameters
  api_instance.test_enum_parameters(opts)
rescue Petstore::ApiError => e
  puts "Exception when calling FakeApi->test_enum_parameters: #{e}"
end

Parameters

Name	Type	Description	Notes
enum_form_string_array	Array<String>	Form parameter enum test (string array)	[optional]
enum_form_string	String	Form parameter enum test (string)	[optional] [default to -efg]
enum_header_string_array	Array<String>	Header parameter enum test (string array)	[optional]
enum_header_string	String	Header parameter enum test (string)	[optional] [default to -efg]
enum_query_string_array	Array<String>	Query parameter enum test (string array)	[optional]
enum_query_string	String	Query parameter enum test (string)	[optional] [default to -efg]
enum_query_integer	Integer	Query parameter enum test (double)	[optional]
enum_query_double	Float	Query parameter enum test (double)	[optional]

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: /
Accept: /

10 KiB Raw Blame History

Petstore::FakeApi

fake_outer_boolean_serialize

Example

Parameters

Return type

Authorization

HTTP request headers

fake_outer_composite_serialize

Example

Parameters

Return type

Authorization

HTTP request headers

fake_outer_number_serialize

Example

Parameters

Return type

Authorization

HTTP request headers

fake_outer_string_serialize

Example

Parameters

Return type

Authorization

HTTP request headers

test_client_model

Example

Parameters

Return type

Authorization

HTTP request headers

test_endpoint_parameters

Example

Parameters

Return type

Authorization

HTTP request headers

test_enum_parameters

Example

Parameters

Return type

Authorization

HTTP request headers

10 KiB

Raw Blame History