アノテーションインターフェース 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 を使用できます。
オプション要素のサマリー
要素の詳細
value
生成されたスニペットが書き込まれる出力ディレクトリ。outputDir()
のエイリアス。- 戻り値:
- 出力ディレクトリ
- デフォルト:
- ""
outputDir
生成されたスニペットが書き込まれる出力ディレクトリ。value()
のエイリアス。- 戻り値:
- 出力ディレクトリ
- デフォルト:
- ""
uriScheme
StringSE uriSchemeドキュメント化された URI で使用されるスキーム(通常はhttp
またはhttps
)。デフォルトはhttp
です。- 戻り値:
- スキーム
- デフォルト:
- "http"
uriHost
StringSE uriHostドキュメント化された URI で使用されるホスト。デフォルトはlocalhost
です。- 戻り値:
- ザホスト
- デフォルト:
- "localhost"
uriPort
int uriPortドキュメント化された URI で使用されるポート。デフォルトは8080
です。- 戻り値:
- 港
- デフォルト:
- 8080