A library that tests if the implementation of a REST-API meets its specification.
Core
SpringConverter
MicronautConverter
OpenApiConverter
Core
SpringConverter
OpenApiConverter
RamlConverter
MicronautConverter
JaxRsConverter
javax.ws.rs.
to jakarta.ws.rs.
Core
MicronautConverter
SpringConverter
OpenApiConverter
Core
SpringConverter
OpenApiConverter
MicronautConverter
RamlConverter
SpringConverter:
MicronautConverter:
Core:
OpenApiConverter:
MicronauConverter:
JaxRsConverter:
RamlConverter:
Core:
HikakuConfig
with dynamic rule set using predicates. See migration guide below Thanks to @jrehwaldt for bringing up this idea in #26 and thanks a lot to @syjer for coming up with a proposal for the implementation in #44
Endpoint
for httpMethod
and path
MicronautConverter:
SpringConverter:
The configuration has changed. You can now freely create rules to exclude endpoints from matching. If you've been using the HikakuConfig
options here is how you can migrate to 3.0.0:
If you previously used the ignoreHttpMethodHead
in the config, change your config to the following:
Kotlin:
HikakuConfig(
filter = listOf (
{ endpoint -> endpoint.httpMethod == HEAD }
),
reporter = listOf(reporter)
)
If you previously used the ignoreHttpMethodOptions
in the config, change your config to the following:
Kotlin:
HikakuConfig(
filter = listOf (
{ endpoint -> endpoint.httpMethod == OPTIONS }
),
reporter = listOf(reporter)
)
If you previously used the ignorePaths
in the config, change your config to the following:
Kotlin:
HikakuConfig(
filter = listOf (
SpringConverter.IGNORE_ERROR_ENDPOINT,
{ endpoint -> endpoint.path == "/other-path"},
),
reporter = listOf(reporter)
)
Of course you can combine all of these as well: Kotlin:
HikakuConfig(
filter = listOf (
{ endpoint -> endpoint.httpMethod == HEAD },
{ endpoint -> endpoint.httpMethod == OPTIONS },
SpringConverter.IGNORE_ERROR_ENDPOINT,
{ endpoint -> endpoint.path == "/other-path"},
),
reporter = listOf(reporter)
)
And you can create more individual rules.
Core:
Core / JaxRsConverter / MicronautConverter / OpenApiConverter / RamlConverter / SpringConverter:
Core / JaxRsConverter / MicronautConverter:
SpringConverter:
MicronautConverter
OpenApiConverter
Core:
OpenApiConverter:
MicronautConverter:
OpenApiConverter:
SpringConverter: