程序包 org.springframework.boot.test.autoconfigure.restdocs

批注接口 AutoConfigureRestDocs

@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited @ImportAutoConfiguration @Import(org.springframework.boot.test.autoconfigure.restdocs.RestDocumentationContextProviderRegistrar.class) @PropertyMapping("spring.test.restdocs") public @interface AutoConfigureRestDocs
Annotation that can be applied to a test class to enable and configure auto-configuration of Spring REST Docs. The auto-configuration sets up MockMvc-based testing of a servlet web application, WebTestClient-based testing of a reactive web application, or RestAssured-based testing of any web application over HTTP.

Allows configuration of the output directory and the host, scheme, and port of generated URIs. When further configuration is required a RestDocsMockMvcConfigurationCustomizer, RestDocsWebTestClientConfigurationCustomizer, or RestDocsRestAssuredConfigurationCustomizer bean can be used.

从以下版本开始:
1.4.0
作者:
Andy Wilkinson
另请参阅:

  • 可选元素概要

    可选元素
    修饰符和类型
    可选元素
    说明
    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.

  • 元素详细资料

    • value

      @AliasFor("outputDir") String value
      The output directory to which generated snippets will be written. An alias for outputDir().
      返回:
      the output directory
      默认值:
      ""

    • outputDir

      @AliasFor("value") String outputDir
      The output directory to which generated snippets will be written. An alias for value().
      返回:
      the output directory
      默认值:
      ""

    • uriScheme

      String uriScheme
      The scheme (typically http or https) to be used in documented URIs. Defaults to http.
      返回:
      the scheme
      默认值:
      "http"

    • uriHost

      String uriHost
      The host to be used in documented URIs. Defaults to localhost.
      返回:
      the host
      默认值:
      "localhost"

    • uriPort

      int uriPort
      The port to be used in documented URIs. Defaults to 8080.
      返回:
      the port
      默认值:
      8080