Package com.maciejwalkowiak.wiremock.spring

Annotation Interface ConfigureWireMock

@Retention(RUNTIME) public @interface ConfigureWireMock
Configures WireMock instance.
Author:
Maciej Walkowiak

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The name of WireMock server.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<? extends WireMockConfigurationCustomizer>[]
    configurationCustomizers
    Customizes WireMockConfiguration used by WireMockServer instance.
    Class<? extends com.github.tomakehurst.wiremock.extension.Extension>[]
    extensions
    WireMock extensions to register in WireMockServer.
    int
    port
    Port on which WireMock server is going to listen.
    String
    property
    The name of Spring property to inject the WireMockServer.baseUrl()
    String
    stubLocation
    The location of WireMock stub files.

  • Element Details

    • name

      String name
      The name of WireMock server.
      Returns:
      the name of WireMock server.

    • port

      int port
      Port on which WireMock server is going to listen. 0 means WireMock will pick random port.
      Returns:
      WireMock server port
      Default:
      0

    • property

      String property
      The name of Spring property to inject the WireMockServer.baseUrl()
      Returns:
      the name of Spring property to inject the WireMockServer.baseUrl()
      Default:
      ""

    • stubLocation

      String stubLocation
      The location of WireMock stub files. By default, stubs are resolved from classpath location wiremock-server-name/mappings/. If provided, stubs are resolved from stub-location/mappings/.
      Returns:
      the stub location
      Default:
      ""

    • extensions

      Class<? extends com.github.tomakehurst.wiremock.extension.Extension>[] extensions
      WireMock extensions to register in WireMockServer.
      Returns:
      the extensions
      Default:
      {}

    • configurationCustomizers

      Class<? extends WireMockConfigurationCustomizer>[] configurationCustomizers
      Customizes WireMockConfiguration used by WireMockServer instance. Customizers are ordered by their natural order in this array. Each customizer must have no-arg constructor.
      Returns:
      the configuration customizers classes
      Default:
      {}