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

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

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

導入:
4.0.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