Uses of Interface
org.springframework.restdocs.operation.OperationResponse
Packages that use 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
Methods in org.springframework.restdocs.hypermedia with parameters of type OperationResponseModifier and TypeMethodDescriptionLinkExtractor.extractLinks(OperationResponse response) Extract the links from the givenresponse, returning aMapof links where the keys are the link rels. -
Uses of OperationResponse in org.springframework.restdocs.operation
Methods in org.springframework.restdocs.operation that return OperationResponseModifier and TypeMethodDescriptionConverts the givenresponseinto anOperationResponse.OperationResponseFactory.create(int status, org.springframework.http.HttpHeaders headers, byte[] content) Creates a newOperationResponsewithout cookies.OperationResponseFactory.create(int status, org.springframework.http.HttpHeaders headers, byte[] content, Collection<ResponseCookie> cookies) Creates a newOperationResponse.OperationResponseFactory.createFrom(OperationResponse original, byte[] newContent) Creates a newOperationResponsebased on the givenoriginalbut with the givennewContent.OperationResponseFactory.createFrom(OperationResponse original, org.springframework.http.HttpHeaders newHeaders) Creates a newOperationResponsebased on the givenoriginalbut with the givennewHeaders.Operation.getResponse()Returns the response that was received.StandardOperation.getResponse()Methods in org.springframework.restdocs.operation with parameters of type OperationResponseModifier and TypeMethodDescriptionOperationResponseFactory.createFrom(OperationResponse original, byte[] newContent) Creates a newOperationResponsebased on the givenoriginalbut with the givennewContent.OperationResponseFactory.createFrom(OperationResponse original, org.springframework.http.HttpHeaders newHeaders) Creates a newOperationResponsebased on the givenoriginalbut with the givennewHeaders.Constructors in org.springframework.restdocs.operation with parameters of type OperationResponseModifierConstructorDescriptionStandardOperation(String name, OperationRequest request, OperationResponse response, Map<String, Object> attributes) Creates a newStandardOperation. -
Uses of OperationResponse in org.springframework.restdocs.operation.preprocess
Methods in org.springframework.restdocs.operation.preprocess that return OperationResponseModifier and TypeMethodDescriptionContentModifyingOperationPreprocessor.preprocess(OperationResponse response) HeadersModifyingOperationPreprocessor.preprocess(OperationResponse response) OperationPreprocessor.preprocess(OperationResponse response) Processes the givenresponse.OperationPreprocessorAdapter.preprocess(OperationResponse response) Returns the givenresponseas-is.OperationResponsePreprocessor.preprocess(OperationResponse response) Processes and potentially modifies the givenresponsebefore it is documented.UriModifyingOperationPreprocessor.preprocess(OperationResponse response) Methods in org.springframework.restdocs.operation.preprocess with parameters of type OperationResponseModifier and TypeMethodDescriptionContentModifyingOperationPreprocessor.preprocess(OperationResponse response) HeadersModifyingOperationPreprocessor.preprocess(OperationResponse response) OperationPreprocessor.preprocess(OperationResponse response) Processes the givenresponse.OperationPreprocessorAdapter.preprocess(OperationResponse response) Returns the givenresponseas-is.OperationResponsePreprocessor.preprocess(OperationResponse response) Processes and potentially modifies the givenresponsebefore it is documented.UriModifyingOperationPreprocessor.preprocess(OperationResponse response)