パッケージ org.springframework.restdocs.config

クラス RestDocumentationConfigurer<S extends AbstractConfigurer,P extends AbstractConfigurer,T>

java.lang.ObjectSE
org.springframework.restdocs.config.RestDocumentationConfigurer<S,P,T>
型パラメーター:
S - SnippetConfigurer の具象型
P - OperationPreprocessorsConfigurer の具象型
T - チェイニングをサポートするメソッドから返される、このコンフィギュアラーの具象型
既知の直属サブクラス
MockMvcRestDocumentationConfigurer、RestAssuredRestDocumentationConfigurer、WebTestClientRestDocumentationConfigurer
public abstract class RestDocumentationConfigurer<S extends AbstractConfigurer,P extends AbstractConfigurer,T> extends ObjectSE
Spring REST Docs の構成の抽象基本クラス。
導入:
1.1.0
作成者:
Andy Wilkinson, Filip Hrisafov

  • コンストラクターの詳細

    • RestDocumentationConfigurer

      public RestDocumentationConfigurer()

  • メソッドの詳細

    • snippets

      public abstract S snippets()
      生成されるスニペットの構成に使用できる SnippetConfigurer を返します。
      戻り値:
      スニペットコンフィギュアラー

    • operationPreprocessors

      public abstract P operationPreprocessors()
      使用される操作リクエストおよびレスポンスプリプロセッサーを構成するために使用できる OperationPreprocessorsConfigurer を返します。
      戻り値:
      オペレーションプリプロセッサーコンフィギュアラー

    • templateEngine

      public final T templateEngine(TemplateEngine templateEngine)
      スニペットのレンダリングに使用される TemplateEngine を構成します。
      パラメーター:
      templateEngine - 使用するテンプレートエンジン
      戻り値:
      this

    • writerResolver

      public final T writerResolver(WriterResolver writerResolver)
      スニペットのライターを解決するために使用される WriterResolver を構成します。
      パラメーター:
      writerResolver - 使用するライターリゾルバー
      戻り値:
      this

    • apply

      protected final void apply(MapSE<StringSE,ObjectSE> configuration, RestDocumentationContext context)
      このコンフィギュアラーを、指定された context 内の指定された configuration に適用します。
      パラメーター:
      configuration - 構成
      context - 現在のコンテキスト