Uses of Interface
org.springframework.restdocs.snippet.Snippet

Packages that use Snippet

Package	Description
org.springframework.restdocs.cli	Documenting CLI commands required to make a request to a RESTful API.
org.springframework.restdocs.config	Classes for configuring Spring REST Docs.
org.springframework.restdocs.generate	Classes that drive the generation of the documentation snippets.
org.springframework.restdocs.headers	Documenting the headers of a RESTful API's requests and responses.
org.springframework.restdocs.http	Documenting the HTTP request sent to a RESTful API and the HTTP response that is returned.
org.springframework.restdocs.hypermedia	Documenting a RESTful API that uses hypermedia.
org.springframework.restdocs.mockmvc	Core classes for using Spring REST Docs with Spring Test's MockMvc.
org.springframework.restdocs.payload	Documenting the payload of a RESTful API's requests and responses.
org.springframework.restdocs.request	Documenting query and path parameters of requests sent to a RESTful API.
org.springframework.restdocs.restassured3	Core classes for using Spring REST Docs with REST Assured 3.
org.springframework.restdocs.snippet	Snippet generation.
org.springframework.restdocs.webtestclient	Core classes for using Spring REST Docs with Spring Framework's WebTestClient.

Uses of Snippet in org.springframework.restdocs.cli

Classes in org.springframework.restdocs.cli that implement Snippet

Modifier and Type	Class and Description
class	CurlRequestSnippet A Snippet that documents the curl command for a request.
class	HttpieRequestSnippet A Snippet that documents the HTTPie command for a request.

Methods in org.springframework.restdocs.cli that return Snippet

Modifier and Type	Method and Description
static Snippet	CliDocumentation.curlRequest() Returns a new Snippet that will document the curl request for the API operation.
static Snippet	CliDocumentation.curlRequest(CommandFormatter commandFormatter) Returns a new Snippet that will document the curl request for the API operation.
static Snippet	CliDocumentation.curlRequest(java.util.Map<java.lang.String,java.lang.Object> attributes) Returns a new Snippet that will document the curl request for the API operation.
static Snippet	CliDocumentation.curlRequest(java.util.Map<java.lang.String,java.lang.Object> attributes, CommandFormatter commandFormatter) Returns a new Snippet that will document the curl request for the API operation.
static Snippet	CliDocumentation.httpieRequest() Returns a new Snippet that will document the HTTPie request for the API operation.
static Snippet	CliDocumentation.httpieRequest(CommandFormatter commandFormatter) Returns a new Snippet that will document the HTTPie request for the API operation.
static Snippet	CliDocumentation.httpieRequest(java.util.Map<java.lang.String,java.lang.Object> attributes) Returns a new Snippet that will document the HTTPie request for the API operation.
static Snippet	CliDocumentation.httpieRequest(java.util.Map<java.lang.String,java.lang.Object> attributes, CommandFormatter commandFormatter) Returns a new Snippet that will document the HTTPie request for the API operation.

Uses of Snippet in org.springframework.restdocs.config

Methods in org.springframework.restdocs.config with parameters of type Snippet

Modifier and Type	Method and Description
TYPE	SnippetConfigurer.withAdditionalDefaults(Snippet... additionalDefaultSnippets) Configures additional documentation snippets that will be produced by default.
TYPE	SnippetConfigurer.withDefaults(Snippet... defaultSnippets) Configures the documentation snippets that will be produced by default.

Uses of Snippet in org.springframework.restdocs.generate

Methods in org.springframework.restdocs.generate with parameters of type Snippet

Modifier and Type	Method and Description
RestDocumentationGenerator<REQ,RESP>	RestDocumentationGenerator.withSnippets(Snippet... snippets) Creates a new RestDocumentationGenerator with the same configuration as this one other than its snippets.

Constructors in org.springframework.restdocs.generate with parameters of type Snippet

Constructor and Description
RestDocumentationGenerator(java.lang.String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Creates a new RestDocumentationGenerator for the operation identified by the given identifier.
RestDocumentationGenerator(java.lang.String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Creates a new RestDocumentationGenerator for the operation identified by the given identifier.
RestDocumentationGenerator(java.lang.String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Creates a new RestDocumentationGenerator for the operation identified by the given identifier.
RestDocumentationGenerator(java.lang.String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, Snippet... snippets) Creates a new RestDocumentationGenerator for the operation identified by the given identifier.

Uses of Snippet in org.springframework.restdocs.headers

Classes in org.springframework.restdocs.headers that implement Snippet

Modifier and Type	Class and Description
class	AbstractHeadersSnippet Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response headers.
class	RequestHeadersSnippet A Snippet that documents the headers in a request.
class	ResponseHeadersSnippet A Snippet that documents the headers in a response.

Uses of Snippet in org.springframework.restdocs.http

Classes in org.springframework.restdocs.http that implement Snippet

Modifier and Type	Class and Description
class	HttpRequestSnippet A Snippet that documents an HTTP request.
class	HttpResponseSnippet A Snippet that documents an HTTP response.

Uses of Snippet in org.springframework.restdocs.hypermedia

Classes in org.springframework.restdocs.hypermedia that implement Snippet

Modifier and Type	Class and Description
class	LinksSnippet A Snippet that documents a RESTful resource's links.

Uses of Snippet in org.springframework.restdocs.mockmvc

Methods in org.springframework.restdocs.mockmvc with parameters of type Snippet

Modifier and Type	Method and Description
RestDocumentationResultHandler	RestDocumentationResultHandler.document(Snippet... snippets) Creates a new RestDocumentationResultHandler to be passed into ResultActions.andDo(ResultHandler) that will produce documentation using the given snippets.
static RestDocumentationResultHandler	MockMvcRestDocumentation.document(java.lang.String identifier, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.
static RestDocumentationResultHandler	MockMvcRestDocumentation.document(java.lang.String identifier, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.
static RestDocumentationResultHandler	MockMvcRestDocumentation.document(java.lang.String identifier, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.
static RestDocumentationResultHandler	MockMvcRestDocumentation.document(java.lang.String identifier, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.

Uses of Snippet in org.springframework.restdocs.payload

Classes in org.springframework.restdocs.payload that implement Snippet

Modifier and Type	Class and Description
class	AbstractBodySnippet Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response body.
class	AbstractFieldsSnippet Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response fields.
class	RequestBodySnippet A Snippet that documents the body of a request.
class	RequestFieldsSnippet A Snippet that documents the fields in a request.
class	RequestPartBodySnippet A Snippet that documents the body of a request part.
class	RequestPartFieldsSnippet A Snippet that documents the fields in a request part.
class	ResponseBodySnippet A Snippet that documents the body of a response.
class	ResponseFieldsSnippet A Snippet that documents the fields in a response.

Uses of Snippet in org.springframework.restdocs.request

Classes in org.springframework.restdocs.request that implement Snippet

Modifier and Type	Class and Description
class	AbstractParametersSnippet Abstract TemplatedSnippet subclass that provides a base for snippets that document parameters from a request sent to a RESTful resource.
class	PathParametersSnippet A Snippet that documents the path parameters supported by a RESTful resource.
class	RequestParametersSnippet A Snippet that documents the request parameters supported by a RESTful resource.
class	RequestPartsSnippet A Snippet that documents the request parts supported by a RESTful resource.

Uses of Snippet in org.springframework.restdocs.restassured3

Methods in org.springframework.restdocs.restassured3 with parameters of type Snippet

Modifier and Type	Method and Description
RestDocumentationFilter	RestDocumentationFilter.document(Snippet... snippets) Creates a new RestDocumentationFilter that will produce documentation using the given snippets.
static RestDocumentationFilter	RestAssuredRestDocumentation.document(java.lang.String identifier, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.
static RestDocumentationFilter	RestAssuredRestDocumentation.document(java.lang.String identifier, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.
static RestDocumentationFilter	RestAssuredRestDocumentation.document(java.lang.String identifier, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.
static RestDocumentationFilter	RestAssuredRestDocumentation.document(java.lang.String identifier, Snippet... snippets) Documents the API call with the given identifier using the given snippets.

Uses of Snippet in org.springframework.restdocs.snippet

Classes in org.springframework.restdocs.snippet that implement Snippet

Modifier and Type	Class and Description
class	TemplatedSnippet Base class for a Snippet that is produced using a Template and TemplateEngine.

Uses of Snippet in org.springframework.restdocs.webtestclient

Methods in org.springframework.restdocs.webtestclient with parameters of type Snippet

Modifier and Type	Method and Description
static <T extends org.springframework.test.web.reactive.server.ExchangeResult> java.util.function.Consumer<T>	WebTestClientRestDocumentation.document(java.lang.String identifier, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.
static <T extends org.springframework.test.web.reactive.server.ExchangeResult> java.util.function.Consumer<T>	WebTestClientRestDocumentation.document(java.lang.String identifier, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.
static <T extends org.springframework.test.web.reactive.server.ExchangeResult> java.util.function.Consumer<T>	WebTestClientRestDocumentation.document(java.lang.String identifier, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the given identifier using the given snippets in addition to any default snippets.
static <T extends org.springframework.test.web.reactive.server.ExchangeResult> java.util.function.Consumer<T>	WebTestClientRestDocumentation.document(java.lang.String identifier, Snippet... snippets) Returns a Consumer that, when called, documents the API call with the given identifier using the given snippets in addition to any default snippets.