Index

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

S

scheme(String) - Method in class org.springframework.restdocs.operation.preprocess.UriModifyingOperationPreprocessor

Modifies the URI to use the given scheme.

set(String, String...) - Method in class org.springframework.restdocs.operation.preprocess.HeadersModifyingOperationPreprocessor

Sets the header with the given name to have the given values.

singleLineFormat() - Static method in class org.springframework.restdocs.cli.CliDocumentation

Creates a new CommandFormatter that produces single-line output.

Snippet - Interface in org.springframework.restdocs.snippet

A Snippet is used to document aspects of a call to a RESTful API.

SnippetConfigurer<PARENT,TYPE> - Class in org.springframework.restdocs.config

A configurer that can be used to configure the generated documentation snippets.

SnippetConfigurer(PARENT) - Constructor for class org.springframework.restdocs.config.SnippetConfigurer

Creates a new SnippetConfigurer with the given parent.

SnippetException - Exception in org.springframework.restdocs.snippet

A RuntimeException thrown to indicate a problem with the generation of a documentation snippet.

SnippetException(String) - Constructor for exception org.springframework.restdocs.snippet.SnippetException

Creates a new SnippetException described by the given message.

snippets() - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer

Returns a SnippetConfigurer that can be used to configure the snippets that will be generated.

snippets() - Method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer

snippets() - Method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer

snippets() - Method in class org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer

StandardOperation - Class in org.springframework.restdocs.operation

Standard implementation of Operation.

StandardOperation(String, OperationRequest, OperationResponse, Map<String, Object>) - Constructor for class org.springframework.restdocs.operation.StandardOperation

Creates a new StandardOperation.

StandardTemplateResourceResolver - Class in org.springframework.restdocs.templates

Standard implementation of TemplateResourceResolver.

StandardTemplateResourceResolver(TemplateFormat) - Constructor for class org.springframework.restdocs.templates.StandardTemplateResourceResolver

Creates a new StandardTemplateResourceResolver that will produce default template resources formatted with the given templateFormat.

StandardWriterResolver - Class in org.springframework.restdocs.snippet

Standard implementation of WriterResolver.

StandardWriterResolver(PlaceholderResolverFactory, String, TemplateFormat) - Constructor for class org.springframework.restdocs.snippet.StandardWriterResolver

Creates a new StandardWriterResolver that will use a PropertyPlaceholderHelper.PlaceholderResolver created from the given placeholderResolverFactory to resolve any placeholders in the operationName.

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

A string.

SubsectionDescriptor - Class in org.springframework.restdocs.payload

A description of a subsection, i.e.

SubsectionDescriptor(String) - Constructor for class org.springframework.restdocs.payload.SubsectionDescriptor

Creates a new SubsectionDescriptor describing the subsection with the given path.

subsectionWithPath(String) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation

Creates a FieldDescriptor that describes a subsection, i.e.

supportsParameter(ParameterContext, ExtensionContext) - Method in class org.springframework.restdocs.RestDocumentationExtension

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form