Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use OpenApiConverter class of de.codecentric.hikaku.converters.openapi package

Best Hikaku code snippet using de.codecentric.hikaku.converters.openapi.OpenApiConverter

OpenApiConverter.kt

Source:OpenApiConverter.kt

...17import java.nio.file.Path18/**19 * Extracts and converts [Endpoint]s from OpenAPI 3.0.X document. Either a *.yaml*, *.yml* or a *.json* file.20 */21class OpenApiConverter private constructor(private val specificationContent: String) : AbstractEndpointConverter() {22    @JvmOverloads23    constructor(openApiSpecification: File, charset: Charset = UTF_8): this(openApiSpecification.toPath(), charset)24    @JvmOverloads25    constructor(openApiSpecification: Path, charset: Charset = UTF_8): this(readFileContent(openApiSpecification, charset))26    override val supportedFeatures = SupportedFeatures(27            Feature.QueryParameters,28            Feature.PathParameters,29            Feature.HeaderParameters,30            Feature.Produces,31            Feature.Consumes,32            Feature.Deprecation33    )34    override fun convert(): Set<Endpoint> {35        try {...

OpenApiConverterHeaderParameterTest.kt

Source:OpenApiConverterHeaderParameterTest.kt

2import de.codecentric.hikaku.endpoints.HeaderParameter3import org.assertj.core.api.Assertions.assertThat4import org.junit.jupiter.api.Test5import java.nio.file.Paths6class OpenApiConverterHeaderParameterTest {7    @Test8    fun `header parameter inline declaration on Operation object`() {9        //given10        val file = Paths.get(this::class.java.classLoader.getResource("header_parameter/header_parameter_inline.yaml").toURI())11        val headerParameters = setOf(12                HeaderParameter("x-b3-traceid", false),13                HeaderParameter("allow-cache", true)14        )15        //when16        val result = OpenApiConverter(file).conversionResult.toList()[0].headerParameters17        //then18        assertThat(result).containsExactlyInAnyOrderElementsOf(headerParameters)19    }20    @Test21    fun `one header parameter declared inline and one parameter referenced from parameters section in components`() {22        //given23        val file = Paths.get(this::class.java.classLoader.getResource("header_parameter/header_parameter_in_components.yaml").toURI())24        val headerParameters = setOf(25                HeaderParameter("x-b3-traceid", false),26                HeaderParameter("allow-cache", true)27        )28        //when29        val result = OpenApiConverter(file).conversionResult.toList()[0].headerParameters30        //then31        assertThat(result).containsExactlyInAnyOrderElementsOf(headerParameters)32    }33    @Test34    fun `common header parameter inline declaration on Operation object`() {35        //given36        val file = Paths.get(this::class.java.classLoader.getResource("header_parameter/common_header_parameter_inline.yaml").toURI())37        val headerParameters = setOf(38                HeaderParameter("x-b3-traceid", false),39                HeaderParameter("allow-cache", true)40        )41        //when42        val result = OpenApiConverter(file).conversionResult.toList()[0].headerParameters43        //then44        assertThat(result).containsExactlyInAnyOrderElementsOf(headerParameters)45    }46    @Test47    fun `one common header parameter declared inline and one parameter referenced from parameters section in components`() {48        //given49        val file = Paths.get(this::class.java.classLoader.getResource("header_parameter/common_header_parameter_in_components.yaml").toURI())50        val headerParameters = setOf(51                HeaderParameter("x-b3-traceid", false),52                HeaderParameter("allow-cache", true)53        )54        //when55        val result = OpenApiConverter(file).conversionResult.toList()[0].headerParameters56        //then57        assertThat(result).containsExactlyInAnyOrderElementsOf(headerParameters)58    }59}...

OpenApiConverterInvalidInputTest.kt

Source:OpenApiConverterInvalidInputTest.kt

...4import org.junit.jupiter.api.Test5import java.io.File6import java.nio.file.Paths7import kotlin.test.assertFailsWith8class OpenApiConverterInvalidInputTest {9    @Nested10    inner class PathObjectTests {11        @Test12        fun `empty file returns an empty list`() {13            //given14            val file = Paths.get(this::class.java.classLoader.getResource("invalid_input/empty_file.yaml").toURI())15            //when16            assertFailsWith<EndpointConverterException> {17                OpenApiConverter(file).conversionResult18            }19        }20        @Test21        fun `file consisting solely of whitespaces returns an empty list`() {22            //given23            val file = Paths.get(this::class.java.classLoader.getResource("invalid_input/whitespaces_only_file.yaml").toURI())24            //when25            assertFailsWith<EndpointConverterException> {26                OpenApiConverter(file).conversionResult27            }28        }29        @Test30        fun `OpenAPI yaml file containing syntax error`() {31            //given32            val file = Paths.get(this::class.java.classLoader.getResource("invalid_input/syntax_error.yaml").toURI())33            val converter = OpenApiConverter(file)34            //when35            assertFailsWith<EndpointConverterException> {36                converter.conversionResult37            }38        }39    }40    @Nested41    inner class FileObjectTests {42        @Test43        fun `empty file returns an empty list`() {44            //given45            val file = File(this::class.java.classLoader.getResource("invalid_input/empty_file.yaml").toURI())46            //when47            assertFailsWith<EndpointConverterException> {48                OpenApiConverter(file).conversionResult49            }50        }51        @Test52        fun `file consisting solely of whitespaces returns an empty list`() {53            //given54                val file = File(this::class.java.classLoader.getResource("invalid_input/whitespaces_only_file.yaml").toURI())55            //when56            assertFailsWith<EndpointConverterException> {57                OpenApiConverter(file).conversionResult58            }59        }60        @Test61        fun `OpenAPI yaml file containing syntax error`() {62            //given63            val file = File(this::class.java.classLoader.getResource("invalid_input/syntax_error.yaml").toURI())64            val converter = OpenApiConverter(file)65            //when66            assertFailsWith<EndpointConverterException> {67                converter.conversionResult68            }69        }70    }71}...

OpenApiConverterProducesTest.kt

Source:OpenApiConverterProducesTest.kt

...4import de.codecentric.hikaku.endpoints.HttpMethod.GET5import org.assertj.core.api.Assertions.assertThat6import org.junit.jupiter.api.Test7import java.nio.file.Paths8class OpenApiConverterProducesTest {9    @Test10    fun `inline declaration`() {11        //given12        val file = Paths.get(this::class.java.classLoader.getResource("produces/produces_inline.yaml").toURI())13        val implementation = setOf(14                Endpoint(15                        path = "/todos",16                        httpMethod = GET,17                        produces = setOf("application/json")18                )19        )20        //when21        val specification = OpenApiConverter(file)22        //then23        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)24    }25    @Test26    fun `no content-type`() {27        //given28        val file = Paths.get(this::class.java.classLoader.getResource("produces/produces_no_content_type.yaml").toURI())29        val implementation = setOf(30                Endpoint("/todos", DELETE)31        )32        //when33        val specification = OpenApiConverter(file)34        //then35        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)36    }37    @Test38    fun `response is declared in components section`() {39        //given40        val file = Paths.get(this::class.java.classLoader.getResource("produces/produces_response_in_components.yaml").toURI())41        val implementation = setOf(42                Endpoint(43                        path = "/todos",44                        httpMethod = GET,45                        produces = setOf("application/xml")46                )47        )48        //when49        val specification = OpenApiConverter(file)50        //then51        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)52    }53    @Test54    fun `produces having a default value`() {55        //given56        val file = Paths.get(this::class.java.classLoader.getResource("produces/produces_with_default.yaml").toURI())57        val implementation = setOf(58                Endpoint(59                        path = "/todos/query",60                        httpMethod = GET,61                        produces = setOf("application/json", "text/plain")62                )63        )64        //when65        val specification = OpenApiConverter(file)66        //then67        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)68    }69}...

OpenApiConverterQueryParameterTest.kt

Source:OpenApiConverterQueryParameterTest.kt

2import de.codecentric.hikaku.endpoints.QueryParameter3import org.assertj.core.api.Assertions.assertThat4import org.junit.jupiter.api.Test5import java.nio.file.Paths6class OpenApiConverterQueryParameterTest {7    @Test8    fun `query parameter inline declaration on Operation object`() {9        //given10        val file = Paths.get(this::class.java.classLoader.getResource("query_parameter/query_parameter_inline.yaml").toURI())11        val queryParameters = setOf(12                QueryParameter("tag", false),13                QueryParameter("limit", true)14        )15        //when16        val result = OpenApiConverter(file).conversionResult.toList()[0].queryParameters17        //then18        assertThat(result).containsExactlyInAnyOrderElementsOf(queryParameters)19    }20    @Test21    fun `one query parameter declared inline and one parameter referenced from parameters section in components`() {22        //given23        val file = Paths.get(this::class.java.classLoader.getResource("query_parameter/query_parameter_in_components.yaml").toURI())24        val queryParameters = setOf(25                QueryParameter("tag", false),26                QueryParameter("limit", true)27        )28        //when29        val result = OpenApiConverter(file).conversionResult.toList()[0].queryParameters30        //then31        assertThat(result).containsExactlyInAnyOrderElementsOf(queryParameters)32    }33    @Test34    fun `common query parameter inline declaration on Operation object`() {35        //given36        val file = Paths.get(this::class.java.classLoader.getResource("query_parameter/common_query_parameter_inline.yaml").toURI())37        val queryParameters = setOf(38                QueryParameter("tag", false),39                QueryParameter("limit", true)40        )41        //when42        val result = OpenApiConverter(file).conversionResult.toList()[0].queryParameters43        //then44        assertThat(result).containsExactlyInAnyOrderElementsOf(queryParameters)45    }46    @Test47    fun `one query parameter declared inline and one common parameter referenced from parameters section in components`() {48        //given49        val file = Paths.get(this::class.java.classLoader.getResource("query_parameter/common_query_parameter_in_components.yaml").toURI())50        val queryParameters = setOf(51                QueryParameter("tag", false),52                QueryParameter("limit", true)53        )54        //when55        val result = OpenApiConverter(file).conversionResult.toList()[0].queryParameters56        //then57        assertThat(result).containsExactlyInAnyOrderElementsOf(queryParameters)58    }59}...

OpenApiConverterEndpointTest.kt

Source:OpenApiConverterEndpointTest.kt

...3import de.codecentric.hikaku.endpoints.HttpMethod.*4import org.assertj.core.api.Assertions.assertThat5import org.junit.jupiter.api.Test6import java.nio.file.Paths7class OpenApiConverterEndpointTest {8    @Test9    fun `extract two different paths`() {10        //given11        val file = Paths.get(this::class.java.classLoader.getResource("endpoints/endpoints_two_different_paths.yaml").toURI())12        val implementation = setOf(13                Endpoint("/todos", GET),14                Endpoint("/tags", GET)15        )16        //when17        val specification = OpenApiConverter(file)18        //then19        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)20    }21    @Test22    fun `extract two paths of which one is nested`() {23        //given24        val file = Paths.get(this::class.java.classLoader.getResource("endpoints/endpoints_two_nested_paths.yaml").toURI())25        val implementation = setOf(26                Endpoint("/todos", GET),27                Endpoint("/todos/query", GET)28        )29        //when30        val specification = OpenApiConverter(file)31        //then32        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)33    }34    @Test35    fun `extract all http methods`() {36        //given37        val file = Paths.get(this::class.java.classLoader.getResource("endpoints/endpoints_all_http_methods.yaml").toURI())38        val implementation = setOf(39                Endpoint("/todos", GET),40                Endpoint("/todos", POST),41                Endpoint("/todos", PUT),42                Endpoint("/todos", PATCH),43                Endpoint("/todos", DELETE),44                Endpoint("/todos", HEAD),45                Endpoint("/todos", OPTIONS),46                Endpoint("/todos", TRACE)47        )48        //when49        val specification = OpenApiConverter(file)50        //then51        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)52    }53}...

OpenApiConverterDeprecationTest.kt

Source:OpenApiConverterDeprecationTest.kt

...3import de.codecentric.hikaku.endpoints.HttpMethod.GET4import org.assertj.core.api.Assertions.assertThat5import org.junit.jupiter.api.Test6import java.nio.file.Paths7class OpenApiConverterDeprecationTest {8    @Test9    fun `no deprecation`() {10        //given11        val file = Paths.get(this::class.java.classLoader.getResource("deprecation/deprecation_none.yaml").toURI())12        val implementation = setOf(13                Endpoint(14                        path = "/todos",15                        httpMethod = GET,16                        produces = setOf("application/json"),17                        deprecated = false18                )19        )20        //when21        val specification = OpenApiConverter(file)22        //then23        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)24    }25    @Test26    fun `deprecated operation`() {27        //given28        val file = Paths.get(this::class.java.classLoader.getResource("deprecation/deprecation_operation.yaml").toURI())29        val implementation = setOf(30                Endpoint(31                        path = "/todos",32                        httpMethod = GET,33                        produces = setOf("application/json"),34                        deprecated = true35                )36        )37        //when38        val specification = OpenApiConverter(file)39        //then40        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)41    }42}...

OpenApiConverterConsumesTest.kt

Source:OpenApiConverterConsumesTest.kt

...3import de.codecentric.hikaku.endpoints.HttpMethod.POST4import org.assertj.core.api.Assertions.assertThat5import org.junit.jupiter.api.Test6import java.nio.file.Paths7class OpenApiConverterConsumesTest {8    @Test9    fun `inline declaration`() {10        //given11        val file = Paths.get(this::class.java.classLoader.getResource("consumes/consumes_inline.yaml").toURI())12        val implementation = setOf(13                Endpoint(14                        path = "/todos",15                        httpMethod = POST,16                        consumes = setOf("application/xml")17                )18        )19        //when20        val specification = OpenApiConverter(file)21        //then22        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)23    }24    @Test25    fun `response is declared in components section`() {26        //given27        val file = Paths.get(this::class.java.classLoader.getResource("consumes/consumes_requestbody_in_components.yaml").toURI())28        val implementation = setOf(29                Endpoint(30                        path = "/todos",31                        httpMethod = POST,32                        consumes = setOf("application/xml")33                )34        )35        //when36        val specification = OpenApiConverter(file)37        //then38        assertThat(specification.conversionResult).containsExactlyInAnyOrderElementsOf(implementation)39    }40}...

OpenApiConverter

Using AI Code Generation

1val openApiConverter = OpenApiConverter(openApi)2val specifications = openApiConverter.convert()3val springMvcConverter = SpringMvcConverter("com.example.controller")4val specifications = springMvcConverter.convert()5val springRestDocsConverter = SpringRestDocsConverter("com.example.controller")6val specifications = springRestDocsConverter.convert()7val swaggerConverter = SwaggerConverter(swagger)8val specifications = swaggerConverter.convert()9val wadlConverter = WadlConverter(wadl)10val specifications = wadlConverter.convert()11val wsdlConverter = WsdlConverter(wsdl)12val specifications = wsdlConverter.convert()13val openApiToSpecificationConverter = OpenApiToSpecificationConverter(openApi)14val specifications = openApiToSpecificationConverter.convert()15val springMvcToSpecificationConverter = SpringMvcToSpecificationConverter("com.example.controller")16val specifications = springMvcToSpecificationConverter.convert()17val springRestDocsToSpecificationConverter = SpringRestDocsToSpecificationConverter("com.example.controller")18val specifications = springRestDocsToSpecificationConverter.convert()19val swaggerToSpecificationConverter = SwaggerToSpecificationConverter(swagger)20val specifications = swaggerToSpecificationConverter.convert()21val wadlToSpecificationConverter = WadlToSpecificationConverter(wadl)22val specifications = wadlToSpecificationConverter.convert()

OpenApiConverter

Using AI Code Generation

1val openApiConverter = OpenApiConverter(openApiSpecification)2val hikakuSet = openApiConverter.toHikakuSet()3val swaggerConverter = SwaggerConverter(swaggerSpecification)4val hikakuSet = swaggerConverter.toHikakuSet()5val restAssuredConverter = RestAssuredConverter(restAssuredSpecification)6val hikakuSet = restAssuredConverter.toHikakuSet()7val springRestDocsConverter = SpringRestDocsConverter(springRestDocsSpecification)8val hikakuSet = springRestDocsConverter.toHikakuSet()9val springMvcConverter = SpringMvcConverter(springMvcSpecification)10val hikakuSet = springMvcConverter.toHikakuSet()11val springWebFluxConverter = SpringWebFluxConverter(springWebFluxSpecification)12val hikakuSet = springWebFluxConverter.toHikakuSet()13val springMvcMockMvcConverter = SpringMvcMockMvcConverter(springMvcMockMvcSpecification)14val hikakuSet = springMvcMockMvcConverter.toHikakuSet()15val springWebFluxWebTestClientConverter = SpringWebFluxWebTestClientConverter(springWebFluxWebTestClientSpecification)16val hikakuSet = springWebFluxWebTestClientConverter.toHikakuSet()17val springMvcMockMvcConverter = SpringMvcMockMvcConverter(springMvcMockMvcSpecification)18val hikakuSet = springMvcMockMvcConverter.toHikakuSet()

OpenApiConverter

Using AI Code Generation

1val openApiConverter = OpenApiConverter(openApiSpec)2val hikakuSpec = openApiConverter.convert()3val restAssuredConverter = RestAssuredConverter(restAssuredSpec)4val hikakuSpec = restAssuredConverter.convert()5val swaggerConverter = SwaggerConverter(swaggerSpec)6val hikakuSpec = swaggerConverter.convert()7val wireMockConverter = WireMockConverter(wireMockSpec)8val hikakuSpec = wireMockConverter.convert()9val hikakuSpec = HikakuSpec(10        endpoints = setOf(11                Endpoint(12                        path = "/users/{id}",13                        requestParameters = setOf(14                                RequestParameter(15                        requestHeaders = setOf(16                                RequestHeader(17                        requestMediaTypes = setOf(18                                MediaType(19                        requestBodies = setOf(20                                RequestBody(21                        responseStatuses = setOf(22                                ResponseStatus(23                        responseHeaders = setOf(24                                ResponseHeader(25                        responseMediaTypes = setOf(26                                MediaType(27                        responseBodies = setOf(28                                ResponseBody(

OpenApiConverter

Using AI Code Generation

1val hikakuSpecification = OpenApiConverter.convert(openApiSpecification)2val hikakuSpecification = HikakuConverter.convert(hikakuSpecification)3val openApiSpecification = SwaggerConverter.convert(hikakuSpecification)4val openApiSpecification = OpenApiConverter.convert(hikakuSpecification)5val hikakuSpecification = HikakuConverter.convert(hikakuSpecification)6val hikakuSpecification = HikakuConverter.convert(hikakuSpecification)7val openApiSpecification = SwaggerConverter.convert(hikakuSpecification)8val openApiSpecification = OpenApiConverter.convert(hikakuSpecification)9val hikakuSpecification = HikakuConverter.convert(hikakuSpecification)10val hikakuSpecification = HikakuConverter.convert(hikakuSpecification)

OpenApiConverter

Using AI Code Generation

1val openApiConverter = OpenApiConverter()2val hikakuConverter = HikakuConverter()3val hikakuSpec: Specification = hikakuConverter.convert(hikakuSpec)4val ramlConverter = RamlConverter()5val swaggerConverter = SwaggerConverter()6val wadlConverter = WadlConverter()7val wsdlConverter = WsdlConverter()8val apiBlueprintConverter = ApiBlueprintConverter()9val asyncApiConverter = AsyncApiConverter()

OpenApiConverter

Using AI Code Generation

1val specification = OpenApiConverter.convertFromPath("src/test/resources/petstore-expanded.yaml")2val contract = HikakuSpecification(3    endpoint = Endpoint("/pet", HttpMethod.GET),4    request = Request(5        header = Header(6            ContentType("application/json")7    response = Response(8        header = Header(9            ContentType("application/json")10        body = Body(11            Json(12                {13                }14                """.trimIndent()15HikakuVerifier(specification).verify(contract)16val specification = OpenApiConverter.convertFromPath("src/test/resources/petstore-expanded.yaml")17val contract = contract {18    endpoint("/pet", HttpMethod.GET) {19        request {20            header {21            }22        }23        response {24            header {25            }26            body {27                    {28                    }29                    """.trimIndent()30            }31        }32    }33}34HikakuVerifier(specification).verify(contract)35HikakuSpecification specification = OpenApiConverter.convertFromPath("

OpenApiConverter

Using AI Code Generation

1val openApiConverter = OpenApiConverter(File("src/test/resources/openapi.yaml")) val hikakuSpecifications = openApiConverter.convert()2val springMvcConverter = SpringMvcConverter(HelloWorldController::class.java) val hikakuSpecifications = springMvcConverter.convert()3val springWebFluxConverter = SpringWebFluxConverter(HelloWorldController::class.java) val hikakuSpecifications = springWebFluxConverter.convert()4val retrofitConverter = RetrofitConverter(HelloWorldService::class.java) val hikakuSpecifications = retrofitConverter.convert()5val jaxRsConverter = JaxRsConverter(HelloWorldResource::class.java) val hikakuSpecifications = jaxRsConverter.convert()6val springWebFluxConverter = SpringWebFluxConverter(HelloWorldController::class.java) val hikakuSpecifications = springWebFluxConverter.convert()7val retrofitConverter = RetrofitConverter(HelloWorldService::class.java) val hikakuSpecifications = retrofitConverter.convert()8val jaxRsConverter = JaxRsConverter(HelloWorldResource::class.java) val hikakuSpecifications = jaxRsConverter.convert()9HikakuVerifier(specification).verify(contract)10val specification = OpenApiConverter.convertFromPath("src/test/resources/petstore-expanded.yaml")11val contract = contract {12    endpoint("/pet", HttpMethod.GET) {13        request {14            header {15            }16        }17        response {18            header {19            }20            body {21                    {22                    }23                    """.trimIndent()24            }25        }26    }27}28HikakuVerifier(specification).verify(contract)29HikakuSpecification specification = OpenApiConverter.convertFromPath("

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.