Uses of Interface
org.springframework.restdocs.operation.OperationRequest
Package
Description
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 OperationRequest in org.springframework.restdocs.operation
Modifier and TypeMethodDescriptionConverts the givenrequest
into anOperationRequest
.OperationRequestFactory.create
(URI uri, org.springframework.http.HttpMethod method, byte[] content, org.springframework.http.HttpHeaders headers, Parameters parameters, Collection<OperationRequestPart> parts) Creates a newOperationRequest
.OperationRequestFactory.create
(URI uri, org.springframework.http.HttpMethod method, byte[] content, org.springframework.http.HttpHeaders headers, Parameters parameters, Collection<OperationRequestPart> parts, Collection<RequestCookie> cookies) Creates a newOperationRequest
.OperationRequestFactory.createFrom
(OperationRequest original, byte[] newContent) Creates a newOperationRequest
based on the givenoriginal
but with the givennewContent
.OperationRequestFactory.createFrom
(OperationRequest original, org.springframework.http.HttpHeaders newHeaders) Creates a newOperationRequest
based on the givenoriginal
but with the givennewHeaders
.OperationRequestFactory.createFrom
(OperationRequest original, Parameters newParameters) Creates a newOperationRequest
based on the givenoriginal
but with the givennewParameters
applied.Operation.getRequest()
Returns the request that was sent.StandardOperation.getRequest()
Modifier and TypeMethodDescriptionOperationRequestFactory.createFrom
(OperationRequest original, byte[] newContent) Creates a newOperationRequest
based on the givenoriginal
but with the givennewContent
.OperationRequestFactory.createFrom
(OperationRequest original, org.springframework.http.HttpHeaders newHeaders) Creates a newOperationRequest
based on the givenoriginal
but with the givennewHeaders
.OperationRequestFactory.createFrom
(OperationRequest original, Parameters newParameters) Creates a newOperationRequest
based on the givenoriginal
but with the givennewParameters
applied.ModifierConstructorDescriptionStandardOperation
(String name, OperationRequest request, OperationResponse response, Map<String, Object> attributes) Creates a newStandardOperation
. -
Uses of OperationRequest in org.springframework.restdocs.operation.preprocess
Modifier and TypeMethodDescriptionContentModifyingOperationPreprocessor.preprocess
(OperationRequest request) OperationPreprocessor.preprocess
(OperationRequest request) Processes the givenrequest
.OperationPreprocessorAdapter.preprocess
(OperationRequest request) Returns the givenrequest
as-is.OperationRequestPreprocessor.preprocess
(OperationRequest request) Processes and potentially modifies the givenrequest
before it is documented.ParametersModifyingOperationPreprocessor.preprocess
(OperationRequest request) UriModifyingOperationPreprocessor.preprocess
(OperationRequest request) Modifier and TypeMethodDescriptionContentModifyingOperationPreprocessor.preprocess
(OperationRequest request) OperationPreprocessor.preprocess
(OperationRequest request) Processes the givenrequest
.OperationPreprocessorAdapter.preprocess
(OperationRequest request) Returns the givenrequest
as-is.OperationRequestPreprocessor.preprocess
(OperationRequest request) Processes and potentially modifies the givenrequest
before it is documented.ParametersModifyingOperationPreprocessor.preprocess
(OperationRequest request) UriModifyingOperationPreprocessor.preprocess
(OperationRequest request)