Uses of Interface
org.springframework.restdocs.operation.OperationResponse
Package
Description
Documenting a RESTful API that uses hypermedia.
Operation API that describes a request that was sent and the response that was received
when calling a RESTful API.
Support for preprocessing an operation prior to it being documented.
-
Uses of OperationResponse in org.springframework.restdocs.hypermedia
Modifier and TypeMethodDescriptionLinkExtractor.extractLinks
(OperationResponse response) Extract the links from the givenresponse
, returning aMap
of links where the keys are the link rels. -
Uses of OperationResponse in org.springframework.restdocs.operation
Modifier and TypeMethodDescriptionConverts the givenresponse
into anOperationResponse
.OperationResponseFactory.create
(org.springframework.http.HttpStatusCode status, org.springframework.http.HttpHeaders headers, byte[] content) Creates a newOperationResponse
without cookies.OperationResponseFactory.create
(org.springframework.http.HttpStatusCode status, org.springframework.http.HttpHeaders headers, byte[] content, Collection<ResponseCookie> cookies) Creates a newOperationResponse
.OperationResponseFactory.createFrom
(OperationResponse original, byte[] newContent) Creates a newOperationResponse
based on the givenoriginal
but with the givennewContent
.OperationResponseFactory.createFrom
(OperationResponse original, org.springframework.http.HttpHeaders newHeaders) Creates a newOperationResponse
based on the givenoriginal
but with the givennewHeaders
.Operation.getResponse()
Returns the response that was received.StandardOperation.getResponse()
Modifier and TypeMethodDescriptionOperationResponseFactory.createFrom
(OperationResponse original, byte[] newContent) Creates a newOperationResponse
based on the givenoriginal
but with the givennewContent
.OperationResponseFactory.createFrom
(OperationResponse original, org.springframework.http.HttpHeaders newHeaders) Creates a newOperationResponse
based on the givenoriginal
but with the givennewHeaders
.ModifierConstructorDescriptionStandardOperation
(String name, OperationRequest request, OperationResponse response, Map<String, Object> attributes) Creates a newStandardOperation
. -
Uses of OperationResponse in org.springframework.restdocs.operation.preprocess
Modifier and TypeMethodDescriptionContentModifyingOperationPreprocessor.preprocess
(OperationResponse response) HeadersModifyingOperationPreprocessor.preprocess
(OperationResponse response) OperationPreprocessor.preprocess
(OperationResponse response) Processes the givenresponse
.OperationPreprocessorAdapter.preprocess
(OperationResponse response) Returns the givenresponse
as-is.OperationResponsePreprocessor.preprocess
(OperationResponse response) Processes and potentially modifies the givenresponse
before it is documented.UriModifyingOperationPreprocessor.preprocess
(OperationResponse response) Modifier and TypeMethodDescriptionContentModifyingOperationPreprocessor.preprocess
(OperationResponse response) HeadersModifyingOperationPreprocessor.preprocess
(OperationResponse response) OperationPreprocessor.preprocess
(OperationResponse response) Processes the givenresponse
.OperationPreprocessorAdapter.preprocess
(OperationResponse response) Returns the givenresponse
as-is.OperationResponsePreprocessor.preprocess
(OperationResponse response) Processes and potentially modifies the givenresponse
before it is documented.UriModifyingOperationPreprocessor.preprocess
(OperationResponse response)