Index
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
nameto have the givenvalues. - set(String, String...) - Method in class org.springframework.restdocs.operation.preprocess.ParametersModifyingOperationPreprocessor
-
Sets the parameter with the given
nameto have the givenvalues. - singleLineFormat() - Static method in class org.springframework.restdocs.cli.CliDocumentation
-
Creates a new
CommandFormatterthat produces single-line output. - Snippet - Interface in org.springframework.restdocs.snippet
-
A
Snippetis 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
SnippetConfigurerwith the givenparent. - SnippetException - Exception in org.springframework.restdocs.snippet
-
A
RuntimeExceptionthrown to indicate a problem with the generation of a documentation snippet. - SnippetException(String) - Constructor for exception org.springframework.restdocs.snippet.SnippetException
-
Creates a new
SnippetExceptiondescribed by the givenmessage. - snippets() - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer
-
Returns a
SnippetConfigurerthat 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
StandardTemplateResourceResolverthat will produce default template resources formatted with the giventemplateFormat. - 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
StandardWriterResolverthat will use aPropertyPlaceholderHelper.PlaceholderResolvercreated from the givenplaceholderResolverFactoryto resolve any placeholders in theoperationName. - 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
SubsectionDescriptordescribing the subsection with the givenpath. - subsectionWithPath(String) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Creates a
FieldDescriptorthat describes a subsection, i.e. - supportsParameter(ParameterContext, ExtensionContext) - Method in class org.springframework.restdocs.RestDocumentationExtension
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form