Uses of Package
org.springframework.restdocs.snippet
Package
Description
Documenting CLI commands required to make a request to a RESTful API.
Classes for configuring Spring REST Docs.
Documenting the cookies of a RESTful API's requests and responses.
Classes that drive the generation of the documentation snippets.
Documenting the headers of a RESTful API's requests and responses.
Documenting the HTTP request sent to a RESTful API and the HTTP response that is
returned.
Documenting a RESTful API that uses hypermedia.
Core classes for using Spring REST Docs with Spring Test's MockMvc.
Documenting the payload of a RESTful API's requests and responses.
Documenting query and path parameters of requests sent to a RESTful API.
Core classes for using Spring REST Docs with REST Assured.
Snippet generation.
Core classes for using Spring REST Docs with Spring Framework's WebTestClient.
-
-
-
ClassDescriptionBase class for descriptors.Base class for descriptors for items that can be ignored.A
Snippet
is used to document aspects of a call to a RESTful API. -
-
ClassDescriptionBase class for descriptors.A
Snippet
is used to document aspects of a call to a RESTful API. -
-
ClassDescriptionBase class for descriptors.Base class for descriptors for items that can be ignored.A
Snippet
is used to document aspects of a call to a RESTful API. -
-
ClassDescriptionBase class for descriptors.Base class for descriptors for items that can be ignored.A
Snippet
is used to document aspects of a call to a RESTful API. -
ClassDescriptionBase class for descriptors.Base class for descriptors for items that can be ignored.A
Snippet
is used to document aspects of a call to a RESTful API. -
-
ClassDescriptionBase class for descriptors.An attribute (key-value pair).A simple builder for an attribute (key-value pair).Base class for descriptors for items that can be ignored.A factory for creating
PropertyPlaceholderHelper.PlaceholderResolver
instances.ASnippet
is used to document aspects of a call to a RESTful API.AWriterResolver
is used to access theWriter
that should be used to write a snippet for an operation that is being documented. -