org.springframework.boot.test.autoconfigure.restdocs

Annotation Type AutoConfigureRestDocs

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      String outputDir
      The output directory to which generated snippets will be written.
      String uriHost
      The host to be used in documented URIs.
      int uriPort
      The port to be used in documented URIs.
      String uriScheme
      The scheme (typically http or https) to be used in documented URIs.
      String value
      The output directory to which generated snippets will be written.
    • Element Detail

      • value

        @AliasFor(value="outputDir")
        public abstract String value
        The output directory to which generated snippets will be written. An alias for outputDir().
        Returns:
        the output directory
        Default:
        ""
      • outputDir

        @AliasFor(value="value")
        public abstract String outputDir
        The output directory to which generated snippets will be written. An alias for value().
        Returns:
        the output directory
        Default:
        ""
      • uriScheme

        public abstract String uriScheme
        The scheme (typically http or https) to be used in documented URIs. Defaults to http.
        Returns:
        the scheme
        Default:
        "http"
      • uriHost

        public abstract String uriHost
        The host to be used in documented URIs. Defaults to localhost.
        Returns:
        the host
        Default:
        "localhost"
      • uriPort

        public abstract int uriPort
        The port to be used in documented URIs. Defaults to 8080.
        Returns:
        the port
        Default:
        8080