SIGN IN SIGN UP

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

0 0 45 Java
2023-10-05 12:55:57 +08:00
# OpenapiClient::HeaderApi
All URIs are relative to *http://localhost:3000*
| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**test_header_integer_boolean_string_enums**](HeaderApi.md#test_header_integer_boolean_string_enums) | **GET** /header/integer/boolean/string/enums | Test header parameter(s) |
2023-10-05 12:55:57 +08:00
## test_header_integer_boolean_string_enums
2023-10-05 12:55:57 +08:00
> String test_header_integer_boolean_string_enums(opts)
2023-10-05 12:55:57 +08:00
Test header parameter(s)
Test header parameter(s)
### Examples
```ruby
require 'time'
require 'openapi_client'
api_instance = OpenapiClient::HeaderApi.new
opts = {
integer_header: 56, # Integer |
boolean_header: true, # Boolean |
string_header: 'string_header_example', # String |
enum_nonref_string_header: 'success', # String |
enum_ref_string_header: OpenapiClient::StringEnumRef::SUCCESS # StringEnumRef |
2023-10-05 12:55:57 +08:00
}
begin
# Test header parameter(s)
result = api_instance.test_header_integer_boolean_string_enums(opts)
2023-10-05 12:55:57 +08:00
p result
rescue OpenapiClient::ApiError => e
puts "Error when calling HeaderApi->test_header_integer_boolean_string_enums: #{e}"
2023-10-05 12:55:57 +08:00
end
```
#### Using the test_header_integer_boolean_string_enums_with_http_info variant
2023-10-05 12:55:57 +08:00
This returns an Array which contains the response data, status code and headers.
> <Array(String, Integer, Hash)> test_header_integer_boolean_string_enums_with_http_info(opts)
2023-10-05 12:55:57 +08:00
```ruby
begin
# Test header parameter(s)
data, status_code, headers = api_instance.test_header_integer_boolean_string_enums_with_http_info(opts)
2023-10-05 12:55:57 +08:00
p status_code # => 2xx
p headers # => { ... }
p data # => String
rescue OpenapiClient::ApiError => e
puts "Error when calling HeaderApi->test_header_integer_boolean_string_enums_with_http_info: #{e}"
2023-10-05 12:55:57 +08:00
end
```
### Parameters
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **integer_header** | **Integer** | | [optional] |
| **boolean_header** | **Boolean** | | [optional] |
| **string_header** | **String** | | [optional] |
| **enum_nonref_string_header** | **String** | | [optional] |
| **enum_ref_string_header** | [**StringEnumRef**](.md) | | [optional] |
2023-10-05 12:55:57 +08:00
### Return type
**String**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain