クラス RequestPartDescriptor

java.lang.ObjectSE
org.springframework.restdocs.snippet.AbstractDescriptor<RequestPartDescriptor>
org.springframework.restdocs.snippet.IgnorableDescriptor<RequestPartDescriptor>
org.springframework.restdocs.request.RequestPartDescriptor
public class RequestPartDescriptor extends IgnorableDescriptor<RequestPartDescriptor>
リクエスト部分の記述子。
導入:
1.1.0
作成者:
Andy Wilkinson
関連事項:

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

    • RequestPartDescriptor

      protected RequestPartDescriptor(StringSE name)
      指定された name でリクエスト部分を記述する新しい RequestPartDescriptor を作成します。
      パラメーター:
      name - リクエスト部分の名前

  • メソッドの詳細

    • optional

      public final RequestPartDescriptor optional()
      リクエスト部分をオプションとしてマークします。
      戻り値:
      this

    • getName

      public final StringSE getName()
      この記述子によって記述されているリクエストパーツの名前を返します。
      戻り値:
      パラメーターの名前

    • isOptional

      public final boolean isOptional()
      記述されたリクエスト部分がオプションの場合は true を返し、そうでない場合は false を返します。
      戻り値:
      記述されたリクエスト部分がオプションの場合は true、それ以外の場合は false