クラス AbstractHeadersSnippet

java.lang.ObjectSE
org.springframework.restdocs.snippet.TemplatedSnippet
org.springframework.restdocs.headers.AbstractHeadersSnippet
実装されているすべてのインターフェース:
Snippet
既知の直属サブクラス
RequestHeadersSnippet, ResponseHeadersSnippet
public abstract class AbstractHeadersSnippet extends TemplatedSnippet
RESTful リソースのリクエストヘッダーまたはレスポンスヘッダーをドキュメント化するスニペットのベースを提供する抽象 TemplatedSnippet サブクラス。
作成者:
Andreas Evers

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

    • AbstractHeadersSnippet

      protected AbstractHeadersSnippet(StringSE type, ListSE<HeaderDescriptor> descriptors, @Nullable MapSE<StringSE,ObjectSE> attributes)
      <type>-headers という名前のスニペットを生成する新しい AbstractHeadersSnippet を作成します。ヘッダーは指定された  descriptors を使用してドキュメント化され、指定された attributes はテンプレートのレンダリング中にモデルに含まれます。
      パラメーター:
      type - ヘッダーの型
      descriptors - ヘッダー記述子
      attributes - 追加の属性

  • メソッドの詳細

    • createModel

      protected MapSE<StringSE,ObjectSE> createModel(Operation operation)
      クラスからコピーされた説明: TemplatedSnippet
      指定された operation をドキュメント化するためにテンプレートのレンダリング中に使用するモデルを作成します。この TemplatedSnippet が作成されたときに提供された追加の属性は、レンダリングの前に自動的にモデルに追加されます。
      次で指定:
      クラス TemplatedSnippet の createModel 
      パラメーター:
      operation - 操作
      戻り値:
      モデル

    • findMissingHeaders

      protected ListSE<HeaderDescriptor> findMissingHeaders(Operation operation)
      操作から欠落しているヘッダーを検索します。ヘッダーが headerDescriptors の 1 つによって記述されているが、操作に存在しない場合、ヘッダーが欠落しています。
      パラメーター:
      operation - 操作
      戻り値:
      操作に欠落しているヘッダーの記述子

    • extractActualHeaders

      protected abstract SetSE<StringSE> extractActualHeaders(Operation operation)
      指定された operation のリクエストまたはレスポンスからヘッダーの名前を抽出します。
      パラメーター:
      operation - 操作
      戻り値:
      ヘッダー名

    • getHeaderDescriptors

      protected final ListSE<HeaderDescriptor> getHeaderDescriptors()
      ドキュメントの生成に使用される HeaderDescriptors のリストを返します。
      戻り値:
      ヘッダー記述子

    • createModelForDescriptor

      protected MapSE<StringSE,ObjectSE> createModelForDescriptor(HeaderDescriptor descriptor)
      指定された descriptor のモデルを返します。
      パラメーター:
      descriptor - 記述子
      戻り値:
      モデル