インデックス

A

AbstractBodySnippet - org.springframework.restdocs.payload のクラス

RESTful リソースのリクエストまたはレスポンス本文をドキュメント化するスニペットのベースを提供する抽象 TemplatedSnippet サブクラス。

AbstractBodySnippet(String, String, PayloadSubsectionExtractor, Map) - クラス org.springframework.restdocs.payload. AbstractBodySnippet のコンストラクター

<type>-body という名前のテンプレートを使用して <name>-body という名前のスニペットを生成する新しい AbstractBodySnippet を作成します。

AbstractBodySnippet(String, PayloadSubsectionExtractor, Map) - クラス org.springframework.restdocs.payload. AbstractBodySnippet のコンストラクター

<type>-body という名前のテンプレートを使用して <type>-body という名前のスニペットを生成する新しい AbstractBodySnippet を作成します。

AbstractConfigurer - org.springframework.restdocs.config のクラス

ドキュメント構成の実装の内部にあるメソッドを宣言する抽象コンフィギュアラー。

AbstractConfigurer() - クラス org.springframework.restdocs.config. AbstractConfigurer のコンストラクター

AbstractCookiesSnippet - org.springframework.restdocs.cookies のクラス

RESTful リソースのリクエストまたはレスポンス Cookie をドキュメント化するスニペットのベースを提供する抽象 TemplatedSnippet サブクラス。

AbstractCookiesSnippet(String, List, Map, boolean) - クラス org.springframework.restdocs.cookies. AbstractCookiesSnippet のコンストラクター

<type>-cookies という名前のスニペットを生成する新しい AbstractCookiesSnippet を作成します。

AbstractDescriptor<T> - org.springframework.restdocs.snippet のクラス

記述子の基本クラス。

AbstractDescriptor() - クラス org.springframework.restdocs.snippet. AbstractDescriptor のコンストラクター

AbstractFieldsSnippet - org.springframework.restdocs.payload のクラス

RESTful リソースのリクエストまたはレスポンスフィールドをドキュメント化するスニペットのベースを提供する抽象 TemplatedSnippet サブクラス。

AbstractFieldsSnippet(String, String, List, Map, boolean) - クラス org.springframework.restdocs.payload. AbstractFieldsSnippet のコンストラクター

<type>-fields という名前のテンプレートを使用して <name>-fields という名前のスニペットを生成する新しい AbstractFieldsSnippet を作成します。

AbstractFieldsSnippet(String, String, List, Map, boolean, PayloadSubsectionExtractor) - クラス org.springframework.restdocs.payload. AbstractFieldsSnippet のコンストラクター

<type>-fields という名前のテンプレートを使用して <name>-fields という名前のスニペットを生成する新しい AbstractFieldsSnippet を作成します。

AbstractFieldsSnippet(String, List, Map, boolean) - クラス org.springframework.restdocs.payload. AbstractFieldsSnippet のコンストラクター

<type>-fields という名前のテンプレートを使用して <type>-fields という名前のスニペットを生成する新しい AbstractFieldsSnippet を作成します。

AbstractFieldsSnippet(String, List, Map, boolean, PayloadSubsectionExtractor) - クラス org.springframework.restdocs.payload. AbstractFieldsSnippet のコンストラクター

<type>-fields という名前のテンプレートを使用して <type>-fields という名前のスニペットを生成する新しい AbstractFieldsSnippet を作成します。

AbstractHeadersSnippet - org.springframework.restdocs.headers のクラス

RESTful リソースのリクエストヘッダーまたはレスポンスヘッダーをドキュメント化するスニペットのベースを提供する抽象 TemplatedSnippet サブクラス。

AbstractHeadersSnippet(String, List, Map) - クラス org.springframework.restdocs.headers. AbstractHeadersSnippet のコンストラクター

<type>-headers という名前のスニペットを生成する新しい AbstractHeadersSnippet を作成します。

AbstractNestedConfigurer<PARENT> - org.springframework.restdocs.config のクラス

NestedConfigurer 実装の基本クラス。

AbstractNestedConfigurer(PARENT) - クラス org.springframework.restdocs.config. AbstractNestedConfigurer のコンストラクター

指定された parent で新しい AbstractNestedConfigurer を作成します。

AbstractParametersSnippet - org.springframework.restdocs.request のクラス

RESTful リソースに送信されたリクエストからパラメーターをドキュメント化するスニペットのベースを提供する抽象 TemplatedSnippet サブクラス。

AbstractParametersSnippet(String, List, Map, boolean) - クラス org.springframework.restdocs.request. AbstractParametersSnippet のコンストラクター

指定された descriptors を使用してパラメーターをドキュメント化する、指定された snippetName でスニペットを生成する新しい AbstractParametersSnippet を作成します。

add(String, String) - クラス org.springframework.restdocs.operation.preprocess のメソッド。HeadersModifyingOperationPreprocessor

指定された name および value でヘッダーを追加します。

afterConfigurerAdded(ConfigurableMockMvcBuilder) - クラス org.springframework.restdocs.mockmvc のメソッド。MockMvcOperationPreprocessorsConfigurer

afterConfigurerAdded(ConfigurableMockMvcBuilder) - クラス org.springframework.restdocs.mockmvc のメソッド。MockMvcRestDocumentationConfigurer

afterConfigurerAdded(ConfigurableMockMvcBuilder) - クラス org.springframework.restdocs.mockmvc のメソッド。MockMvcSnippetConfigurer

afterConfigurerAdded(ConfigurableMockMvcBuilder) - クラス org.springframework.restdocs.mockmvc のメソッド。UriConfigurer

afterEach(ExtensionContext) - Method in class org.springframework.restdocs.RestDocumentationExtension

afterTest() - Method in class org.springframework.restdocs.ManualRestDocumentation

テストが完了したことを通知します。

and() - クラス org.springframework.restdocs.config のメソッド。AbstractNestedConfigurer

and(List) - クラス org.springframework.restdocs.cookies のメソッド。RequestCookiesSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestCookiesSnippet を返します。

and(List) - クラス org.springframework.restdocs.cookies のメソッド。ResponseCookiesSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい ResponseCookiesSnippet を返します。

and(List) - クラス org.springframework.restdocs.headers のメソッド。RequestHeadersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestHeadersSnippet を返します。

and(List) - クラス org.springframework.restdocs.headers のメソッド。ResponseHeadersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい ResponseHeadersSnippet を返します。

and(List) - クラス org.springframework.restdocs.hypermedia のメソッド。LinksSnippet

このスニペットのリンクエクストラクターと属性、および指定された additionalDescriptors と結合されたその記述子で構成された新しい LinksSnippet を返します。

and(List) - クラス org.springframework.restdocs.payload のメソッド。RequestFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestFieldsSnippet を返します。

and(List) - クラス org.springframework.restdocs.payload のメソッド。RequestPartFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestPartFieldsSnippet を返します。

and(List) - クラス org.springframework.restdocs.payload のメソッド。ResponseFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい ResponseFieldsSnippet を返します。

and(List) - クラス org.springframework.restdocs.request のメソッド。FormParametersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい FormParametersSnippet を返します。

and(List) - クラス org.springframework.restdocs.request のメソッド。PathParametersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい PathParametersSnippet を返します。

and(List) - クラス org.springframework.restdocs.request のメソッド。QueryParametersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい QueryParametersSnippet を返します。

and(List) - クラス org.springframework.restdocs.request のメソッド。RequestPartsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestPartsSnippet を返します。

and(CookieDescriptor...) - クラス org.springframework.restdocs.cookies のメソッド。RequestCookiesSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestCookiesSnippet を返します。

and(CookieDescriptor...) - クラス org.springframework.restdocs.cookies のメソッド。ResponseCookiesSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい ResponseCookiesSnippet を返します。

and(HeaderDescriptor...) - クラス org.springframework.restdocs.headers のメソッド。RequestHeadersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestHeadersSnippet を返します。

and(HeaderDescriptor...) - クラス org.springframework.restdocs.headers のメソッド。ResponseHeadersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい ResponseHeadersSnippet を返します。

and(LinkDescriptor...) - クラス org.springframework.restdocs.hypermedia のメソッド。LinksSnippet

このスニペットのリンクエクストラクターと属性、および指定された additionalDescriptors と結合されたその記述子で構成された新しい LinksSnippet を返します。

and(FieldDescriptor...) - クラス org.springframework.restdocs.payload のメソッド。RequestFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestFieldsSnippet を返します。

and(FieldDescriptor...) - クラス org.springframework.restdocs.payload のメソッド。RequestPartFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestPartFieldsSnippet を返します。

and(FieldDescriptor...) - クラス org.springframework.restdocs.payload のメソッド。ResponseFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい ResponseFieldsSnippet を返します。

and(ParameterDescriptor...) - クラス org.springframework.restdocs.request のメソッド。FormParametersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい FormParametersSnippet を返します。

and(ParameterDescriptor...) - クラス org.springframework.restdocs.request のメソッド。PathParametersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい PathParametersSnippet を返します。

and(ParameterDescriptor...) - クラス org.springframework.restdocs.request のメソッド。QueryParametersSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい QueryParametersSnippet を返します。

and(RequestPartDescriptor...) - クラス org.springframework.restdocs.request のメソッド。RequestPartsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestPartsSnippet を返します。

andWithPrefix(String, List) - クラス org.springframework.restdocs.payload のメソッド。RequestFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestFieldsSnippet を返します。

andWithPrefix(String, List) - クラス org.springframework.restdocs.payload のメソッド。RequestPartFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestFieldsSnippet を返します。

andWithPrefix(String, List) - クラス org.springframework.restdocs.payload のメソッド。ResponseFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい ResponseFieldsSnippet を返します。

andWithPrefix(String, FieldDescriptor...) - クラス org.springframework.restdocs.payload のメソッド。RequestFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestFieldsSnippet を返します。

andWithPrefix(String, FieldDescriptor...) - クラス org.springframework.restdocs.payload のメソッド。RequestPartFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい RequestFieldsSnippet を返します。

andWithPrefix(String, FieldDescriptor...) - クラス org.springframework.restdocs.payload のメソッド。ResponseFieldsSnippet

このスニペットの属性とその記述子を指定された additionalDescriptors と組み合わせて構成された新しい ResponseFieldsSnippet を返します。

apply(Map, RestDocumentationContext) - クラス org.springframework.restdocs.config のメソッド。AbstractConfigurer

指定された configuration に構成プログラムを適用します。

apply(Map, RestDocumentationContext) - クラス org.springframework.restdocs.config のメソッド。OperationPreprocessorsConfigurer

apply(Map, RestDocumentationContext) - クラス org.springframework.restdocs.config のメソッド。RestDocumentationConfigurer

このコンフィギュアラーを、指定された context 内の指定された configuration に適用します。

apply(Map, RestDocumentationContext) - クラス org.springframework.restdocs.config のメソッド。SnippetConfigurer

apply(Map, RestDocumentationContext) - クラス org.springframework.restdocs.mockmvc のメソッド。UriConfigurer

applyPathPrefix(String, List) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation

指定された pathPrefix がパスに適用された、指定された descriptors のコピーを作成します。

ARRAY - Enum constant in enum class org.springframework.restdocs.payload.JsonFieldType

配列。

asciidoctor() - Static method in class org.springframework.restdocs.templates.TemplateFormats

ID asciidoctor とファイル拡張子 adoc を持つ Asciidoctor テンプレート形式を返します。

AsciidoctorTableCellContentLambda - org.springframework.restdocs.templates.mustache のクラス

テーブルのフォーマットを壊さないように | 文字をエスケープする Mustache.Lambda。

AsciidoctorTableCellContentLambda() - クラス org.springframework.restdocs.templates.mustache. AsciidoctorTableCellContentLambda のコンストラクター

atomLinks() - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation

links という名前の配列で見つかったリンクを Atom 形式で抽出できる LinkExtractor を返します。

Attribute(String, Object) - クラス org.springframework.restdocs.snippet のコンストラクター。Attributes.Attribute

指定された key および value で新しい属性を作成します。

ATTRIBUTE_NAME_DEFAULT_OPERATION_REQUEST_PREPROCESSOR - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator

デフォルトの操作リクエストプリプロセッサーを保持するために使用される操作属性の名前。

ATTRIBUTE_NAME_DEFAULT_OPERATION_RESPONSE_PREPROCESSOR - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator

デフォルトの操作レスポンスプリプロセッサーを保持するために使用される操作属性の名前。

ATTRIBUTE_NAME_DEFAULT_SNIPPETS - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator

デフォルトのスニペットの ListSE を保持するために使用される操作属性の名前。

ATTRIBUTE_NAME_URL_TEMPLATE - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator

リクエストの URL テンプレートを保持するために使用される操作属性の名前。

attributes(Attributes.Attribute...) - クラス org.springframework.restdocs.snippet のメソッド。AbstractDescriptor

指定された attributes を記述子に追加します。

attributes(Attributes.Attribute...) - Static method in class org.springframework.restdocs.snippet.Attributes

指定された attributes の Map を作成します。

Attributes - Class in org.springframework.restdocs.snippet

属性のマップを作成するための流れるような API。

Attributes.Attribute - org.springframework.restdocs.snippet のクラス

属性 (キーと値のペア)。

Attributes.AttributeBuilder - org.springframework.restdocs.snippet のクラス

属性 (キーと値のペア) の単純なビルダー。