Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
H
- halLinks() - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a
LinkExtractor
capable of extracting links in Hypermedia Application Language (HAL) format where the links are found in a map named_links
. - handle(MvcResult) - Method in class org.springframework.restdocs.mockmvc.RestDocumentationResultHandler
- handle(REQ, RESP, Map<String, Object>) - Method in class org.springframework.restdocs.generate.RestDocumentationGenerator
-
Handles the given
request
andresponse
, producing documentation snippets for them using the givenconfiguration
. - hashCode() - Method in class org.springframework.restdocs.hypermedia.Link
- head(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilder
for a HEAD request. - head(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilder
for a HEAD request. - HeaderDescriptor - Class in org.springframework.restdocs.headers
-
A description of a header found in a request or response.
- HeaderDescriptor(String) - Constructor for class org.springframework.restdocs.headers.HeaderDescriptor
-
Creates a new
HeaderDescriptor
describing the header with the givenname
. - HeaderDocumentation - Class in org.springframework.restdocs.headers
-
Static factory methods for documenting a RESTful API's request and response headers.
- headerWithName(String) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation
-
Creates a
HeaderDescriptor
that describes a header with the givenname
. - host(String) - Method in class org.springframework.restdocs.operation.preprocess.UriModifyingOperationPreprocessor
-
Modifies the URI to use the given
host
. - HttpDocumentation - Class in org.springframework.restdocs.http
-
Static factory methods for documenting a RESTful API's HTTP requests.
- httpieRequest() - Static method in class org.springframework.restdocs.cli.CliDocumentation
-
Returns a new
Snippet
that will document the HTTPie request for the API operation. - httpieRequest(Map<String, Object>) - Static method in class org.springframework.restdocs.cli.CliDocumentation
-
Returns a new
Snippet
that will document the HTTPie request for the API operation. - httpieRequest(Map<String, Object>, CommandFormatter) - Static method in class org.springframework.restdocs.cli.CliDocumentation
-
Returns a new
Snippet
that will document the HTTPie request for the API operation. - httpieRequest(CommandFormatter) - Static method in class org.springframework.restdocs.cli.CliDocumentation
-
Returns a new
Snippet
that will document the HTTPie request for the API operation. - HttpieRequestSnippet - Class in org.springframework.restdocs.cli
-
A
Snippet
that documents the HTTPie command for a request. - HttpieRequestSnippet(Map<String, Object>, CommandFormatter) - Constructor for class org.springframework.restdocs.cli.HttpieRequestSnippet
-
Creates a new
HttpieRequestSnippet
with the given additionalattributes
that will be included in the model during template rendering. - HttpieRequestSnippet(CommandFormatter) - Constructor for class org.springframework.restdocs.cli.HttpieRequestSnippet
-
Creates a new
HttpieRequestSnippet
that will use the givencommandFormatter
to format the HTTPie command. - httpRequest() - Static method in class org.springframework.restdocs.http.HttpDocumentation
-
Returns a new
Snippet
that will document the HTTP request for the API operation. - httpRequest(Map<String, Object>) - Static method in class org.springframework.restdocs.http.HttpDocumentation
-
Returns a new
Snippet
that will document the HTTP request for the API operation. - HttpRequestSnippet - Class in org.springframework.restdocs.http
-
A
Snippet
that documents an HTTP request. - HttpRequestSnippet() - Constructor for class org.springframework.restdocs.http.HttpRequestSnippet
-
Creates a new
HttpRequestSnippet
with no additional attributes. - HttpRequestSnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.http.HttpRequestSnippet
-
Creates a new
HttpRequestSnippet
with the given additionalattributes
that will be included in the model during template rendering. - httpResponse() - Static method in class org.springframework.restdocs.http.HttpDocumentation
-
Returns a
Snippet
that will document the HTTP response for the API operation. - httpResponse(Map<String, Object>) - Static method in class org.springframework.restdocs.http.HttpDocumentation
-
Returns a
Snippet
that will document the HTTP response for the API operation. - HttpResponseSnippet - Class in org.springframework.restdocs.http
-
A
Snippet
that documents an HTTP response. - HttpResponseSnippet() - Constructor for class org.springframework.restdocs.http.HttpResponseSnippet
-
Creates a new
HttpResponseSnippet
with no additional attributes. - HttpResponseSnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.http.HttpResponseSnippet
-
Creates a new
HttpResponseSnippet
with the given additionalattributes
that will be included in the model during template rendering. - HypermediaDocumentation - Class in org.springframework.restdocs.hypermedia
-
Static factory methods for documenting a RESTful API that utilizes Hypermedia.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form