パッケージ org.springframework.boot.test.autoconfigure.restdocs

アノテーションインターフェース AutoConfigureRestDocs

@TargetSE(TYPESE) @RetentionSE(RUNTIMESE) @DocumentedSE @InheritedSE @ImportAutoConfiguration @Import(org.springframework.boot.test.autoconfigure.restdocs.RestDocumentationContextProviderRegistrar.class) @PropertyMapping("spring.test.restdocs") public @interface AutoConfigureRestDocs
Spring REST Docs の自動構成を有効にして構成するためにテストクラスに適用できるアノテーション。自動構成は、サーブレット Web アプリケーションの MockMvc ベースのテスト、リアクティブ Web アプリケーションの WebTestClient ベースのテスト、HTTP を介した Web アプリケーションの RestAssured ベースのテストを設定します。

出力ディレクトリと、生成された URI のホスト、スキーム、ポートの構成を許可します。さらに構成が必要な場合は、RestDocsMockMvcConfigurationCustomizer、RestDocsWebTestClientConfigurationCustomizer、RestDocsRestAssuredConfigurationCustomizer Bean を使用できます。

導入:
1.4.0
作成者:
Andy Wilkinson
関連事項:

  • オプション要素のサマリー

    オプション要素
    修飾子と型
    オプションの要素
    説明
    StringSE
    outputDir
    生成されたスニペットが書き込まれる出力ディレクトリ。
    StringSE
    uriHost
    ドキュメント化された URI で使用されるホスト。
    int
    uriPort
    ドキュメント化された URI で使用されるポート。
    StringSE
    uriScheme
    ドキュメント化された URI で使用されるスキーム（通常は http または https）。
    StringSE
    value
    生成されたスニペットが書き込まれる出力ディレクトリ。

  • 要素の詳細

    • value

      @AliasFor("outputDir") StringSE value
      生成されたスニペットが書き込まれる出力ディレクトリ。outputDir() のエイリアス。
      戻り値:
      出力ディレクトリ
      デフォルト:
      ""

    • outputDir

      @AliasFor("value") StringSE outputDir
      生成されたスニペットが書き込まれる出力ディレクトリ。value() のエイリアス。
      戻り値:
      出力ディレクトリ
      デフォルト:
      ""

    • uriScheme

      StringSE uriScheme
      ドキュメント化された URI で使用されるスキーム（通常は http または https）。デフォルトは http です。
      戻り値:
      スキーム
      デフォルト:
      "http"

    • uriHost

      StringSE uriHost
      ドキュメント化された URI で使用されるホスト。デフォルトは localhost です。
      戻り値:
      ザホスト
      デフォルト:
      "localhost"

    • uriPort

      int uriPort
      ドキュメント化された URI で使用されるポート。デフォルトは 8080 です。
      戻り値:
      港
      デフォルト:
      8080