loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-04 04:06:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/master' into 2.3.0

Browse Source
This commit is contained in:
wing328
2017-06-19 11:23:58 +08:00
parent e0ec454891 3a32857790
commit c988afa766
189 changed files with 9195 additions and 8560 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
samples/client/petstore/javascript-es6/docs/FakeApi.md
View File

@@ -11,6 +11,7 @@ Method | HTTP request | Description
[**testClientModel**](FakeApi.md#testClientModel) | **PATCH** /fake | To test \"client\" model
[**testEndpointParameters**](FakeApi.md#testEndpointParameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
[**testEnumParameters**](FakeApi.md#testEnumParameters) | **GET** /fake | To test enum parameters
[**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data
<a name="fakeOuterBooleanSerialize"></a>
@@ -23,22 +24,21 @@ Test serialization of outer boolean types
### Example
```javascript
var SwaggerPetstore = require('swagger_petstore');
import SwaggerPetstore from 'swagger_petstore';
var apiInstance = new SwaggerPetstore.FakeApi();
let apiInstance = new SwaggerPetstore.FakeApi();
var opts = {
let opts = {
'body': new SwaggerPetstore.OuterBoolean() // OuterBoolean | Input boolean as post body
};
var callback = function(error, data, response) {
apiInstance.fakeOuterBooleanSerialize(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.fakeOuterBooleanSerialize(opts, callback);
});
```
### Parameters
@@ -70,22 +70,21 @@ Test serialization of object with outer number type
### Example
```javascript
var SwaggerPetstore = require('swagger_petstore');
import SwaggerPetstore from 'swagger_petstore';
var apiInstance = new SwaggerPetstore.FakeApi();
let apiInstance = new SwaggerPetstore.FakeApi();
var opts = {
let opts = {
'body': new SwaggerPetstore.OuterComposite() // OuterComposite | Input composite as post body
};
var callback = function(error, data, response) {
apiInstance.fakeOuterCompositeSerialize(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.fakeOuterCompositeSerialize(opts, callback);
});
```
### Parameters
@@ -117,22 +116,21 @@ Test serialization of outer number types
### Example
```javascript
var SwaggerPetstore = require('swagger_petstore');
import SwaggerPetstore from 'swagger_petstore';
var apiInstance = new SwaggerPetstore.FakeApi();
let apiInstance = new SwaggerPetstore.FakeApi();
var opts = {
let opts = {
'body': new SwaggerPetstore.OuterNumber() // OuterNumber | Input number as post body
};
var callback = function(error, data, response) {
apiInstance.fakeOuterNumberSerialize(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.fakeOuterNumberSerialize(opts, callback);
});
```
### Parameters
@@ -164,22 +162,21 @@ Test serialization of outer string types
### Example
```javascript
var SwaggerPetstore = require('swagger_petstore');
import SwaggerPetstore from 'swagger_petstore';
var apiInstance = new SwaggerPetstore.FakeApi();
let apiInstance = new SwaggerPetstore.FakeApi();
var opts = {
let opts = {
'body': new SwaggerPetstore.OuterString() // OuterString | Input string as post body
};
var callback = function(error, data, response) {
apiInstance.fakeOuterStringSerialize(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.fakeOuterStringSerialize(opts, callback);
});
```
### Parameters
@@ -211,21 +208,20 @@ To test \&quot;client\&quot; model
### Example
```javascript
var SwaggerPetstore = require('swagger_petstore');
import SwaggerPetstore from 'swagger_petstore';
var apiInstance = new SwaggerPetstore.FakeApi();
let apiInstance = new SwaggerPetstore.FakeApi();
var body = new SwaggerPetstore.Client(); // Client | client model
let body = new SwaggerPetstore.Client(); // Client | client model
var callback = function(error, data, response) {
apiInstance.testClientModel(body, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.testClientModel(body, callback);
});
```
### Parameters
@@ -257,25 +253,25 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン
### Example
```javascript
var SwaggerPetstore = require('swagger_petstore');
var defaultClient = SwaggerPetstore.ApiClient.instance;
import SwaggerPetstore from 'swagger_petstore';
let defaultClient = SwaggerPetstore.ApiClient.instance;
// Configure HTTP basic authorization: http_basic_test
var http_basic_test = defaultClient.authentications['http_basic_test'];
let http_basic_test = defaultClient.authentications['http_basic_test'];
http_basic_test.username = 'YOUR USERNAME';
http_basic_test.password = 'YOUR PASSWORD';
var apiInstance = new SwaggerPetstore.FakeApi();
let apiInstance = new SwaggerPetstore.FakeApi();
var _number = 3.4; // Number | None
let _number = 3.4; // Number | None
var _double = 1.2; // Number | None
let _double = 1.2; // Number | None
var patternWithoutDelimiter = "patternWithoutDelimiter_example"; // String | None
let patternWithoutDelimiter = "patternWithoutDelimiter_example"; // String | None
var _byte = B; // Blob | None
let _byte = B; // Blob | None
var opts = {
let opts = {
'integer': 56, // Number | None
'int32': 56, // Number | None
'int64': 789, // Number | None
@@ -288,14 +284,13 @@ var opts = {
'callback': "callback_example" // String | None
};
var callback = function(error, data, response) {
apiInstance.testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts, callback);
});
```
### Parameters
@@ -340,11 +335,11 @@ To test enum parameters
### Example
```javascript
var SwaggerPetstore = require('swagger_petstore');
import SwaggerPetstore from 'swagger_petstore';
var apiInstance = new SwaggerPetstore.FakeApi();
let apiInstance = new SwaggerPetstore.FakeApi();
var opts = {
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)
@@ -355,14 +350,13 @@ var opts = {
'enumQueryDouble': 1.2 // Number | Query parameter enum test (double)
};
var callback = function(error, data, response) {
apiInstance.testEnumParameters(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.testEnumParameters(opts, callback);
});
```
### Parameters
@@ -391,3 +385,51 @@ No authorization required
- **Content-Type**: */*
- **Accept**: */*
<a name="testJsonFormData"></a>
# **testJsonFormData**
> testJsonFormData(param, param2)
test json serialization of form data
### Example
```javascript
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