mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-05-25 11:00:52 +00:00
* Add jsdoc for usePromises, add @link for callbacks * Update petstore samples * Improve jsdoc for void return type + usePromises * Add back curly brackets correctly in model template * Add link to Promise doc in jsdoc comment * Fix jsdoc annotation for callApi method The return type annotation was also broken here.
3.7 KiB
3.7 KiB
SwaggerPetstore.FakeApi
All URIs are relative to http://petstore.swagger.io/v2
Method | HTTP request | Description |
---|---|---|
testEndpointParameters | POST /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 |
testEnumQueryParameters | GET /fake | To test enum query parameters |
testEndpointParameters
testEndpointParameters(_number, _double, _string, _byte, opts)
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Example
var SwaggerPetstore = require('swagger_petstore');
var apiInstance = new SwaggerPetstore.FakeApi();
var _number = 3.4; // Number | None
var _double = 1.2; // Number | None
var _string = "_string_example"; // String | None
var _byte = "B"; // String | None
var opts = {
'integer': 56, // Integer | None
'int32': 56, // Integer | None
'int64': 789, // Integer | None
'_float': 3.4, // Number | None
'binary': "B", // String | 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
};
apiInstance.testEndpointParameters(_number, _double, _string, _byte, opts).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
Parameters
Name | Type | Description | Notes |
---|---|---|---|
_number | Number | None | |
_double | Number | None | |
_string | String | None | |
_byte | String | None | |
integer | Integer | None | [optional] |
int32 | Integer | None | [optional] |
int64 | Integer | None | [optional] |
_float | Number | None | [optional] |
binary | String | None | [optional] |
_date | Date | None | [optional] |
dateTime | Date | None | [optional] |
password | String | None | [optional] |
Return type
null (empty response body)
Authorization
No authorization required
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
testEnumQueryParameters
testEnumQueryParameters(opts)
To test enum query parameters
Example
var SwaggerPetstore = require('swagger_petstore');
var apiInstance = new SwaggerPetstore.FakeApi();
var opts = {
'enumQueryString': "-efg", // String | Query parameter enum test (string)
'enumQueryInteger': 3.4, // Number | Query parameter enum test (double)
'enumQueryDouble': 1.2 // Number | Query parameter enum test (double)
};
apiInstance.testEnumQueryParameters(opts).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
Parameters
Name | Type | Description | Notes |
---|---|---|---|
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: application/json
- Accept: application/json