* fix schema/definition name as 'file' * update samples * Trigger CI due to previous Shippable race condition * add fix with toModelName(openAPIType) * update tests for file schema/definition name * Update 3.0 test spec * update samples * update samples for jaxrs-cxf * Trigger CI due to previous Shippable race condition * add back explode
14 KiB
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 | |
| testBodyWithFileSchema | PUT /fake/body-with-file-schema | |
| testBodyWithQueryParams | PUT /fake/body-with-query-params | |
| 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
Boolean fakeOuterBooleanSerialize(body)
Test serialization of outer boolean types
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.fakeOuterBooleanSerialize().execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Boolean | Input boolean as post body | [optional] |
Return type
Boolean
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: /
fakeOuterCompositeSerialize
OuterComposite fakeOuterCompositeSerialize(outerComposite)
Test serialization of object with outer number type
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.fakeOuterCompositeSerialize().execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| outerComposite | OuterComposite | Input composite as post body | [optional] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: /
fakeOuterNumberSerialize
BigDecimal fakeOuterNumberSerialize(body)
Test serialization of outer number types
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.fakeOuterNumberSerialize().execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | BigDecimal | Input number as post body | [optional] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: /
fakeOuterStringSerialize
String fakeOuterStringSerialize(body)
Test serialization of outer string types
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.fakeOuterStringSerialize().execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | String | Input string as post body | [optional] |
Return type
String
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: /
testBodyWithFileSchema
testBodyWithFileSchema(fileSchemaTestClass)
For this test, the body for this request much reference a schema named `File`.
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.testBodyWithFileSchema()
.body(fileSchemaTestClass).execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| fileSchemaTestClass | FileSchemaTestClass |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
testBodyWithQueryParams
testBodyWithQueryParams(query, user)
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.testBodyWithQueryParams()
.queryQuery(query)
.body(user).execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| query | String | ||
| user | User |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
testClientModel
Client testClientModel(client)
To test "client" model
To test "client" model
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.testClientModel()
.body(client).execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| client | Client | client model |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
testEndpointParameters
testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback)
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.testEndpointParameters()
.numberForm(number)
._doubleForm(_double)
.patternWithoutDelimiterForm(patternWithoutDelimiter)
._byteForm(_byte).execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| number | BigDecimal | None | [default to null] |
| _double | Double | None | [default to null] |
| patternWithoutDelimiter | String | None | [default to null] |
| _byte | byte[] | None | [default to null] |
| integer | Integer | None | [optional] [default to null] |
| int32 | Integer | None | [optional] [default to null] |
| int64 | Long | None | [optional] [default to null] |
| _float | Float | None | [optional] [default to null] |
| string | String | None | [optional] [default to null] |
| binary | File | None | [optional] [default to null] |
| date | LocalDate | None | [optional] [default to null] |
| dateTime | OffsetDateTime | None | [optional] [default to null] |
| password | String | None | [optional] [default to null] |
| paramCallback | String | None | [optional] [default to null] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: Not defined
testEnumParameters
testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString)
To test enum parameters
To test enum parameters
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.testEnumParameters().execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enumHeaderStringArray | List<String> | Header parameter enum test (string array) | [optional] [enum: >, $] |
| enumHeaderString | String | Header parameter enum test (string) | [optional] [default to -efg] [enum: _abc, -efg, (xyz)] |
| enumQueryStringArray | List<String> | Query parameter enum test (string array) | [optional] [enum: >, $] |
| enumQueryString | String | Query parameter enum test (string) | [optional] [default to -efg] [enum: _abc, -efg, (xyz)] |
| enumQueryInteger | Integer | Query parameter enum test (double) | [optional] [enum: 1, -2] |
| enumQueryDouble | Double | Query parameter enum test (double) | [optional] [enum: 1.1, -1.2] |
| enumFormStringArray | List<String> | Form parameter enum test (string array) | [optional] [default to $] [enum: >, $] |
| enumFormString | String | Form parameter enum test (string) | [optional] [default to -efg] [enum: _abc, -efg, (xyz)] |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: Not defined
testInlineAdditionalProperties
testInlineAdditionalProperties(requestBody)
test inline additionalProperties
Example
// Import classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.testInlineAdditionalProperties()
.body(requestBody).execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| requestBody | Map<String, String> | 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 classes:
//import org.openapitools.client.ApiClient;
//import io.restassured.builder.RequestSpecBuilder;
//import io.restassured.filter.log.ErrorLoggingFilter;
FakeApi api = ApiClient.api(ApiClient.Config.apiConfig().withReqSpecSupplier(
() -> new RequestSpecBuilder()
.setBaseUri("http://petstore.swagger.io:80/v2"))).fake();
api.testJsonFormData()
.paramForm(param)
.param2Form(param2).execute(r -> r.prettyPeek());
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| param | String | field1 | [default to null] |
| param2 | String | field2 | [default to null] |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: Not defined