codecentric/hikaku
A library that tests if the implementation of a REST-API meets its specification.
📋 Changes
- Updated kotlin to 1.5.21
- Updated spring-webmvc to 5.3.9
- _Support all media-types for consumes_ (#58) | _Thanks to @iazel for providing this pr_
- Updated micronaut-http to 3.0.0
- Updated swagger-parser-v3 to 2.0.27
📋 Changes
- Updated kotlin to 1.4.21
- Updated spring-webmvc to 5.3.3
- Fixed: _Regex error in regex replacement_ (#55) | _Thanks to @mahieddine-ichir for reporting this issue_
- Updated swagger-parser-v3 to 2.0.24
- Updated raml-parser-2 to 1.0.51
- Updated micronaut-http to 2.2.3
- Updated jakarta.ws.rs-api to 3.0.0
- This essentially changes the package from `javax.ws.rs.` to `jakarta.ws.rs.`
📋 Changes
- Updated kotlin to 1.3.72
- Updated micronaut-http to 1.3.3
- Updated spring-webmvc to 5.2.5.RELEASE
- Fixed: _Spring Redirect Endpoint : produces attribute not empty_ (#50) thanks to @drapej for reporting this issue
- Updated swagger-parser-v3 to 2.0.19
📋 Changes
- Updated kotlin to 1.3.61
- Updated spring-webmvc to 5.2.3.RELEASE
- Updated swagger-parser-v3 to 2.0.17
- Updated micronaut-http to 1.2.6
- Updated raml-parser-2 to 1.0.48
📋 Changes
- Updated spring-webmvc to 5.2.0
- Updated micronaut-http to 1.2.5
📋 Changes
- Updated kotlin to 1.3.50
- Updated swagger-parser-v3 to 2.0.15
- Updated micronaut-http to 1.2.4
- Updated jakarta.ws.rs-api to 2.1.6
- Updated raml-parser-2 to 1.0.41
📦 Migrating to 3.0.0
- 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:
📦 ignoreHttpMethodHead
- If you previously used the `ignoreHttpMethodHead` in the config, change your config to the following:
- Kotlin:
- ```kotlin
- HikakuConfig(
- filter = listOf (
- { endpoint -> endpoint.httpMethod == HEAD }
- ),
- reporter = listOf(reporter)
- + 2 more
📦 ignoreHttpMethodOptions
- If you previously used the `ignoreHttpMethodOptions` in the config, change your config to the following:
- Kotlin:
- ```kotlin
- HikakuConfig(
- filter = listOf (
- { endpoint -> endpoint.httpMethod == OPTIONS }
- ),
- reporter = listOf(reporter)
- + 2 more
📦 ignorePaths
- If you previously used the `ignorePaths` in the config, change your config to the following:
- Kotlin:
- ```kotlin
- HikakuConfig(
- filter = listOf (
- SpringConverter.IGNORE_ERROR_ENDPOINT,
- { endpoint -> endpoint.path == "/other-path"},
- ),
- + 3 more
📦 Combined
- Of course you can combine all of these as well:
- Kotlin:
- ```kotlin
- HikakuConfig(
- filter = listOf (
- { endpoint -> endpoint.httpMethod == HEAD },
- { endpoint -> endpoint.httpMethod == OPTIONS },
- SpringConverter.IGNORE_ERROR_ENDPOINT,
- + 6 more
**Core:** + Updated kotlin to 1.3.41 **Core / JaxRsConverter / MicronautConverter / OpenApiConverter / RamlConverter / SpringConverter:** + New feature that checks the deprecation status of endpoints #40 _Thanks to @uuf6429 for contributing this_ **Core / JaxRsConverter / MicronautConverter:** + ClassLocator adapted for windows systems which fixes #38 **SpringConverter:** + Updated spring-mvc to 5.1.8.RELEASE + Hikaku is now able to handle endpoints using HttpServletResponse parameters which used to result in empty produces (#36 and #39) _Thanks to @uuf6429 for contributing this_ **MicronautConverter** + Updated micronaut-http to 1.1.3 + Only the base features had been activated. This has been fixed now. **OpenApiConverter** + Updated swagger-parser to 2.0.13 + Added support for [common parameters](https://swagger.io/docs/specification/describing-parameters/#common) _Thanks to @uuf6429 for contributing this_
📋 Changes
- Initial creation (#34)
- Base feature support (http method and path)
- Support for query parameters
- Support for path parameters
- Support for header parameters
- Support for consumes
- Support for produces
**OpenApiConverter:** + Updated swagger parser to 2.0.11 **SpringConverter:** + Updated spring-webmvc to 5.1.6.RELEASE
📋 Changes
- Added new feature _MatrixParameters_
- Updated swagger parser to 2.0.9
- Added support for matrix parameters
- Added support for matrix parameters
- Initial creation (#29)
- Base feature support (http method and path)
- Support for query parameters
- Support for path parameters
- + 4 more
📋 Changes
- Fixed: Wrong file encoding leads to unclear error message (closes #27)
- Added missing feature activations for produces/consumes
- Added possibility to change charset for file in WadlConverter according to #28
📋 Changes
- Renamed package _de.codecentric.hikaku.converter_ to _de.codecentric.hikaku.converters_
- Renamed package _de.codecentric.hikaku.reporter_ to _de.codecentric.hikaku.reporters_
- Added base features as static output to the CommandLineReporter
- Extracted file validity check to the core and created an extension function for it
- Added a generic EndpointConverterException. OpenApiConverter, WadlConverter and RamlConverter throw the same exception consistently
- Initial creation
- Base feature support (http method and path)
- Support for query parameters
- + 8 more
📋 Changes
- Fixed that response media type was not extracted for `@RestController` annotation [#22](https://github.com/codecentric/hikaku/issues/22)
📋 Changes
- Added KDoc
- Split into separate modules
- Added support for multiple Reporter
- Changed granularity for the matching which leads to:
- Only one `MatchResult` is being generated which differs between Endpoints that were expected, but not found and Endpoints that were not expected, but have been found.
- Improved usage in Java instantiating the HikakuConfig
- Added header parameter support
- Added support for request media types
- + 14 more
First release including support for Spring, OpenAPI and WADL. To see a list of supported Checks, see the `docs/features.md`
