openapi-generator/samples/client/petstore/javascript-es6/docs/FakeApi.md

SwaggerPetstore.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
testInlineAdditionalProperties	POST /fake/inline-additionalProperties	test inline additionalProperties
testJsonFormData	GET /fake/jsonFormData	test json serialization of form data

fakeOuterBooleanSerialize

OuterBoolean fakeOuterBooleanSerialize(opts)

Test serialization of outer boolean types

Example

import SwaggerPetstore from 'swagger_petstore';

let apiInstance = new SwaggerPetstore.FakeApi();

let opts = { 
  'body': new SwaggerPetstore.OuterBoolean() // OuterBoolean | Input boolean as post body
};

apiInstance.fakeOuterBooleanSerialize(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

fakeOuterCompositeSerialize

OuterComposite fakeOuterCompositeSerialize(opts)

Test serialization of object with outer number type

Example

import SwaggerPetstore from 'swagger_petstore';

let apiInstance = new SwaggerPetstore.FakeApi();

let opts = { 
  'body': new SwaggerPetstore.OuterComposite() // OuterComposite | Input composite as post body
};

apiInstance.fakeOuterCompositeSerialize(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

OuterNumber fakeOuterNumberSerialize(opts)

Test serialization of outer number types

Example

import SwaggerPetstore from 'swagger_petstore';

let apiInstance = new SwaggerPetstore.FakeApi();

let opts = { 
  'body': new SwaggerPetstore.OuterNumber() // OuterNumber | Input number as post body
};

apiInstance.fakeOuterNumberSerialize(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

fakeOuterStringSerialize

OuterString fakeOuterStringSerialize(opts)

Test serialization of outer string types

Example

import SwaggerPetstore from 'swagger_petstore';

let apiInstance = new SwaggerPetstore.FakeApi();

let opts = { 
  'body': new SwaggerPetstore.OuterString() // OuterString | Input string as post body
};

apiInstance.fakeOuterStringSerialize(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

testClientModel

Client testClientModel(body)

To test "client" model

To test "client" model

Example

import SwaggerPetstore from 'swagger_petstore';

let apiInstance = new SwaggerPetstore.FakeApi();

let body = new SwaggerPetstore.Client(); // Client | client model


apiInstance.testClientModel(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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, opts)

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

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

Example

import SwaggerPetstore from 'swagger_petstore';
let defaultClient = SwaggerPetstore.ApiClient.instance;

// Configure HTTP basic authorization: http_basic_test
let http_basic_test = defaultClient.authentications['http_basic_test'];
http_basic_test.username = 'YOUR USERNAME';
http_basic_test.password = 'YOUR PASSWORD';

let apiInstance = new SwaggerPetstore.FakeApi();

let _number = 3.4; // Number | None

let _double = 1.2; // Number | None

let patternWithoutDelimiter = "patternWithoutDelimiter_example"; // String | None

let _byte = _byte_example; // Blob | None

let opts = { 
  'integer': 56, // Number | None
  'int32': 56, // Number | None
  'int64': 789, // Number | None
  '_float': 3.4, // Number | None
  '_string': "_string_example", // String | None
  'binary': B, // Blob | None
  '_date': new Date("2013-10-20"), // Date | None
  'dateTime': new Date("2013-10-20T19:20:30+01:00"), // Date | None
  'password': "password_example", // String | None
  'callback': "callback_example" // String | None
};

apiInstance.testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
_number	Number	None
_double	Number	None
patternWithoutDelimiter	String	None
_byte	Blob	None
integer	Number	None	[optional]
int32	Number	None	[optional]
int64	Number	None	[optional]
_float	Number	None	[optional]
_string	String	None	[optional]
binary	Blob	None	[optional]
_date	Date	None	[optional]
dateTime	Date	None	[optional]
password	String	None	[optional]
callback	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(opts)

To test enum parameters

To test enum parameters

Example

import SwaggerPetstore from 'swagger_petstore';

let apiInstance = new SwaggerPetstore.FakeApi();

let opts = { 
  'enumFormStringArray': ["enumFormStringArray_example"], // [String] | Form parameter enum test (string array)
  'enumFormString': "-efg", // String | Form parameter enum test (string)
  'enumHeaderStringArray': ["enumHeaderStringArray_example"], // [String] | Header parameter enum test (string array)
  'enumHeaderString': "-efg", // String | Header parameter enum test (string)
  'enumQueryStringArray': ["enumQueryStringArray_example"], // [String] | Query parameter enum test (string array)
  'enumQueryString': "-efg", // String | Query parameter enum test (string)
  'enumQueryInteger': 56, // Number | Query parameter enum test (double)
  'enumQueryDouble': 1.2 // Number | Query parameter enum test (double)
};

apiInstance.testEnumParameters(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
enumFormStringArray	**[String]**	Form parameter enum test (string array)	[optional]
enumFormString	String	Form parameter enum test (string)	[optional] [default to -efg]
enumHeaderStringArray	**[String]**	Header parameter enum test (string array)	[optional]
enumHeaderString	String	Header parameter enum test (string)	[optional] [default to -efg]
enumQueryStringArray	**[String]**	Query parameter enum test (string array)	[optional]
enumQueryString	String	Query parameter enum test (string)	[optional] [default to -efg]
enumQueryInteger	Number	Query parameter enum test (double)	[optional]
enumQueryDouble	Number	Query parameter enum test (double)	[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: /
• Accept: /

testInlineAdditionalProperties

testInlineAdditionalProperties(param)

test inline additionalProperties

Example

import SwaggerPetstore from 'swagger_petstore';

let apiInstance = new SwaggerPetstore.FakeApi();

let param = null; // Object | request body


apiInstance.testInlineAdditionalProperties(param, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
param	Object	request body

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

testJsonFormData

testJsonFormData(param, param2)

test json serialization of form data

Example

import SwaggerPetstore from 'swagger_petstore';

let apiInstance = new SwaggerPetstore.FakeApi();

let param = "param_example"; // String | field1

let param2 = "param2_example"; // String | field2


apiInstance.testJsonFormData(param, param2, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
param	String	field1
param2	String	field2

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: Not defined