hikaku

A library that tests if the implementation of a REST-API meets its specification.

APACHE-2.0 License

Stars
197
Committers
8

Bot releases are hidden (Show)

hikaku - v3.3.0 Latest Release

Published by cc-jhr about 3 years ago

Core

  • Updated kotlin to 1.5.21

SpringConverter

  • Updated spring-webmvc to 5.3.9
  • Support all media-types for consumes (#58) | Thanks to @iazel for providing this pr

MicronautConverter

  • Updated micronaut-http to 3.0.0

OpenApiConverter

  • Updated swagger-parser-v3 to 2.0.27
hikaku - v3.2.0

Published by cc-jhr over 3 years ago

Core

  • Updated kotlin to 1.4.21

SpringConverter

  • Updated spring-webmvc to 5.3.3
  • Fixed: Regex error in regex replacement (#55) | Thanks to @mahieddine-ichir for reporting this issue

OpenApiConverter

  • Updated swagger-parser-v3 to 2.0.24

RamlConverter

  • Updated raml-parser-2 to 1.0.51

MicronautConverter

  • Updated micronaut-http to 2.2.3

JaxRsConverter

  • Updated jakarta.ws.rs-api to 3.0.0
    • This essentially changes the package from javax.ws.rs. to jakarta.ws.rs.
hikaku - v3.1.2

Published by cc-jhr over 4 years ago

Core

  • Updated kotlin to 1.3.72

MicronautConverter

  • Updated micronaut-http to 1.3.3

SpringConverter

  • Updated spring-webmvc to 5.2.5.RELEASE
  • Fixed: Spring Redirect Endpoint : produces attribute not empty (#50) thanks to @drapej for reporting this issue

OpenApiConverter

  • Updated swagger-parser-v3 to 2.0.19
hikaku - v3.1.1

Published by cc-jhr over 4 years ago

Core

  • Updated kotlin to 1.3.61

SpringConverter

  • Updated spring-webmvc to 5.2.3.RELEASE

OpenApiConverter

  • Updated swagger-parser-v3 to 2.0.17

MicronautConverter

  • Updated micronaut-http to 1.2.6

RamlConverter

  • Updated raml-parser-2 to 1.0.48
hikaku - v3.1.0

Published by cc-jhr almost 5 years ago

SpringConverter:

  • Updated spring-webmvc to 5.2.0

MicronautConverter:

  • Updated micronaut-http to 1.2.5
hikaku - v3.0.1

Published by cc-jhr about 5 years ago

Core:

  • Updated kotlin to 1.3.50

OpenApiConverter:

  • Updated swagger-parser-v3 to 2.0.15

MicronauConverter:

  • Updated micronaut-http to 1.2.4

JaxRsConverter:

  • Updated jakarta.ws.rs-api to 2.1.6

RamlConverter:

  • Updated raml-parser-2 to 1.0.41
hikaku - v3.0.0

Published by cc-jhr about 5 years ago

Core:

  • Replaced static filtering rules in 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
  • Removed default values in Endpoint for httpMethod and path

MicronautConverter:

  • Updated micronaut-http to 1.2.0

SpringConverter:

  • Updated spring-webmvc to 5.1.9.RELEASE

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:

HikakuConfig(
        filter = listOf (
                { endpoint -> endpoint.httpMethod == HEAD }
        ),
        reporter = listOf(reporter)
)

ignoreHttpMethodOptions

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)
)

ignorePaths

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)
)

Combined

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.

hikaku - v2.3.0

Published by cc-jhr over 5 years ago

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 Thanks to @uuf6429 for contributing this
hikaku - v2.2.0

Published by cc-jhr over 5 years ago

Core:

  • Updated kotlin to 1.3.31

OpenApiConverter:

  • Updated swagger parser to 2.0.12

MicronautConverter:

  • 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
hikaku - v2.1.1

Published by cc-jhr over 5 years ago

OpenApiConverter:

  • Updated swagger parser to 2.0.11

SpringConverter:

  • Updated spring-webmvc to 5.1.6.RELEASE
hikaku - v.2.1.0

Published by cc-jhr over 5 years ago

General:

  • Added new feature MatrixParameters

OpenApiConverter:

  • Updated swagger parser to 2.0.9

SpringConverter:

  • Added support for matrix parameters

WadlConverter:

  • Added support for matrix parameters

JaxRsConverter:

  • Initial creation (#29)
    • Base feature support (http method and path)
    • Support for query parameters
    • Support for path parameters
    • Support for header parameters
    • Support for matrix parameters
    • Support for consumes
    • Support for produces
hikaku - v.2.0.1

Published by cc-jhr over 5 years ago

OpenApiConverter:

  • Fixed: Wrong file encoding leads to unclear error message (closes #27)

RAML Converter:

  • Added missing feature activations for produces/consumes

WadlConverter:

  • Added possibility to change charset for file in WadlConverter according to #28
hikaku - v2.0.0

Published by cc-jhr over 5 years ago

General

  • 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

RamlConverter

  • Initial creation
    • 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

  • Removed static methods usingPath() and usingFile in Java usage. Use constructors instead. For kotlin users nothing changes.
  • Fixed: Parameters referenced from components are not detected (#23)

SpringConverter

  • Fixed: Endpoints provide default media type for 'produces' if there is no return type (#24)

WadlConverter

  • Removed static methods usingPath() and usingFile in Java usage. Use constructors instead. For kotlin users nothing changes.
hikaku - v1.1.1

Published by cc-jhr over 5 years ago

SpringConverter

  • Fixed that response media type was not extracted for @RestController annotation #22
hikaku - v1.1.0

Published by cc-jhr over 5 years ago

General:

  • 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

SpringConverter:

  • Added header parameter support
  • Added support for request media types
  • Added support for response media types

OpenApiConverter:

  • Removed constructor awaiting String, because it was misleading
  • Added header parameter support
  • Improved usage in Java by providing usingFile() and usingPath()
  • Added support for request media types
  • Added support for response media types

WadlConverter:

  • Removed constructor awaiting String, because it was misleading
  • Added query parameter support
  • Added path parameter support
  • Added header parameter support
  • Added support for request media types
  • Added support for response media types
  • Improved usage in Java by providing usingFile() and usingPath()
  • The path won't be normalized anymore
hikaku -

Published by cc-jhr over 5 years ago

First release including support for Spring, OpenAPI and WADL. To see a list of supported Checks, see the docs/features.md

Package Rankings
Top 8.17% on Proxy.golang.org
Top 19.87% on Repo1.maven.org
Badges
Extracted from project README
Build Status Maven Central Version
Related Projects