Uses of Interface
org.springframework.restdocs.operation.OperationRequest
Packages that use 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
Methods in org.springframework.restdocs.operation that return OperationRequestModifier and TypeMethodDescriptionConverts the givenrequestinto 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 newOperationRequestbased on the givenoriginalbut with the givennewContent.OperationRequestFactory.createFrom(OperationRequest original, org.springframework.http.HttpHeaders newHeaders) Creates a newOperationRequestbased on the givenoriginalbut with the givennewHeaders.OperationRequestFactory.createFrom(OperationRequest original, Parameters newParameters) Creates a newOperationRequestbased on the givenoriginalbut with the givennewParametersapplied.Operation.getRequest()Returns the request that was sent.StandardOperation.getRequest()Methods in org.springframework.restdocs.operation with parameters of type OperationRequestModifier and TypeMethodDescriptionOperationRequestFactory.createFrom(OperationRequest original, byte[] newContent) Creates a newOperationRequestbased on the givenoriginalbut with the givennewContent.OperationRequestFactory.createFrom(OperationRequest original, org.springframework.http.HttpHeaders newHeaders) Creates a newOperationRequestbased on the givenoriginalbut with the givennewHeaders.OperationRequestFactory.createFrom(OperationRequest original, Parameters newParameters) Creates a newOperationRequestbased on the givenoriginalbut with the givennewParametersapplied.Constructors in org.springframework.restdocs.operation with parameters of type OperationRequestModifierConstructorDescriptionStandardOperation(String name, OperationRequest request, OperationResponse response, Map<String, Object> attributes) Creates a newStandardOperation. -
Uses of OperationRequest in org.springframework.restdocs.operation.preprocess
Methods in org.springframework.restdocs.operation.preprocess that return OperationRequestModifier and TypeMethodDescriptionContentModifyingOperationPreprocessor.preprocess(OperationRequest request) HeadersModifyingOperationPreprocessor.preprocess(OperationRequest request) OperationPreprocessor.preprocess(OperationRequest request) Processes the givenrequest.OperationPreprocessorAdapter.preprocess(OperationRequest request) Returns the givenrequestas-is.OperationRequestPreprocessor.preprocess(OperationRequest request) Processes and potentially modifies the givenrequestbefore it is documented.ParametersModifyingOperationPreprocessor.preprocess(OperationRequest request) UriModifyingOperationPreprocessor.preprocess(OperationRequest request) Methods in org.springframework.restdocs.operation.preprocess with parameters of type OperationRequestModifier and TypeMethodDescriptionContentModifyingOperationPreprocessor.preprocess(OperationRequest request) HeadersModifyingOperationPreprocessor.preprocess(OperationRequest request) OperationPreprocessor.preprocess(OperationRequest request) Processes the givenrequest.OperationPreprocessorAdapter.preprocess(OperationRequest request) Returns the givenrequestas-is.OperationRequestPreprocessor.preprocess(OperationRequest request) Processes and potentially modifies the givenrequestbefore it is documented.ParametersModifyingOperationPreprocessor.preprocess(OperationRequest request) UriModifyingOperationPreprocessor.preprocess(OperationRequest request)