クラス QueryParametersSnippet

java.lang.ObjectSE
org.springframework.restdocs.snippet.TemplatedSnippet
org.springframework.restdocs.request.AbstractParametersSnippet
org.springframework.restdocs.request.QueryParametersSnippet
実装されているすべてのインターフェース:
Snippet
public class QueryParametersSnippet extends AbstractParametersSnippet
RESTful リソースによってサポートされるクエリパラメーターをドキュメント化する Snippet。
導入:
3.0.0
作成者:
Andy Wilkinson
関連事項:

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

    • QueryParametersSnippet

      protected QueryParametersSnippet(ListSE<ParameterDescriptor> descriptors)
      指定された descriptors を使用して、リクエストのクエリパラメーターをドキュメント化する新しい QueryParametersSnippet を作成します。ドキュメント化されていないパラメーターは失敗を引き起こします。
      パラメーター:
      descriptors - パラメーター記述子

    • QueryParametersSnippet

      protected QueryParametersSnippet(ListSE<ParameterDescriptor> descriptors, boolean ignoreUndocumentedParameters)
      指定された descriptors を使用して、リクエストのクエリパラメーターをドキュメント化する新しい QueryParametersSnippet を作成します。ignoreUndocumentedParameters が true の場合、ドキュメント化されていないパラメーターは無視され、障害はトリガーされません。
      パラメーター:
      descriptors - パラメーター記述子
      ignoreUndocumentedParameters - ドキュメント化されていないパラメーターを無視するかどうか

    • QueryParametersSnippet

      protected QueryParametersSnippet(ListSE<ParameterDescriptor> descriptors, @Nullable MapSE<StringSE,ObjectSE> attributes)
      指定された descriptors を使用して、リクエストのクエリパラメーターをドキュメント化する新しい QueryParametersSnippet を作成します。指定された attributes は、テンプレートのレンダリング中にモデルに含まれます。ドキュメント化されていないパラメーターは失敗を引き起こします。
      パラメーター:
      descriptors - パラメーター記述子
      attributes - 追加の属性

    • QueryParametersSnippet

      protected QueryParametersSnippet(ListSE<ParameterDescriptor> descriptors, @Nullable MapSE<StringSE,ObjectSE> attributes, boolean ignoreUndocumentedParameters)
      指定された descriptors を使用して、リクエストのクエリパラメーターをドキュメント化する新しい QueryParametersSnippet を作成します。指定された attributes は、テンプレートのレンダリング中にモデルに含まれます。ignoreUndocumentedParameters が true の場合、ドキュメント化されていないパラメーターは無視され、障害はトリガーされません。
      パラメーター:
      descriptors - パラメーター記述子
      attributes - 追加の属性
      ignoreUndocumentedParameters - ドキュメント化されていないパラメーターを無視するかどうか

  • メソッドの詳細

    • verificationFailed

      protected void verificationFailed(SetSE<StringSE> undocumentedParameters, SetSE<StringSE> missingParameters)
      クラスからコピーされた説明: AbstractParametersSnippet
      ドキュメント化されたパラメーターが実際のパラメーターと一致しない場合に呼び出されます。
      次で指定:
      クラス AbstractParametersSnippet の verificationFailed 
      パラメーター:
      undocumentedParameters - 操作で見つかったがドキュメント化されていないパラメーター
      missingParameters - ドキュメント化されたが操作で見つからなかったパラメーター

    • extractActualParameters

      protected SetSE<StringSE> extractActualParameters(Operation operation)
      クラスからコピーされた説明: AbstractParametersSnippet
      指定された operation に存在していたパラメーターの名前を抽出します。
      次で指定:
      クラス AbstractParametersSnippet の extractActualParameters 
      パラメーター:
      operation - 操作
      戻り値:
      パラメーター

    • and

      public QueryParametersSnippet and(ParameterDescriptor... additionalDescriptors)
      このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい QueryParametersSnippet を返します。
      パラメーター:
      additionalDescriptors - 追加の記述子
      戻り値:
      新しいスニペット

    • and

      public QueryParametersSnippet and(ListSE<ParameterDescriptor> additionalDescriptors)
      このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい QueryParametersSnippet を返します。
      パラメーター:
      additionalDescriptors - 追加の記述子
      戻り値:
      新しいスニペット