Package | Description |
---|---|
org.springframework.restdocs.operation |
Operation API that describes a request that was sent and the response that was received
when calling a RESTful API.
|
org.springframework.restdocs.operation.preprocess |
Support for preprocessing an operation prior to it being documented.
|
Modifier and Type | Method and Description |
---|---|
OperationRequest |
RequestConverter.convert(R request)
Converts the given
request into an OperationRequest . |
OperationRequest |
OperationRequestFactory.create(java.net.URI uri,
org.springframework.http.HttpMethod method,
byte[] content,
org.springframework.http.HttpHeaders headers,
Parameters parameters,
java.util.Collection<OperationRequestPart> parts)
Creates a new
OperationRequest . |
OperationRequest |
OperationRequestFactory.create(java.net.URI uri,
org.springframework.http.HttpMethod method,
byte[] content,
org.springframework.http.HttpHeaders headers,
Parameters parameters,
java.util.Collection<OperationRequestPart> parts,
java.util.Collection<RequestCookie> cookies)
Creates a new
OperationRequest . |
OperationRequest |
OperationRequestFactory.createFrom(OperationRequest original,
byte[] newContent)
Creates a new
OperationRequest based on the given original but with
the given newContent . |
OperationRequest |
OperationRequestFactory.createFrom(OperationRequest original,
org.springframework.http.HttpHeaders newHeaders)
Creates a new
OperationRequest based on the given original but with
the given newHeaders . |
OperationRequest |
OperationRequestFactory.createFrom(OperationRequest original,
Parameters newParameters)
Creates a new
OperationRequest based on the given original but with
the given newParameters applied. |
OperationRequest |
Operation.getRequest()
Returns the request that was sent.
|
OperationRequest |
StandardOperation.getRequest() |
Modifier and Type | Method and Description |
---|---|
OperationRequest |
OperationRequestFactory.createFrom(OperationRequest original,
byte[] newContent)
Creates a new
OperationRequest based on the given original but with
the given newContent . |
OperationRequest |
OperationRequestFactory.createFrom(OperationRequest original,
org.springframework.http.HttpHeaders newHeaders)
Creates a new
OperationRequest based on the given original but with
the given newHeaders . |
OperationRequest |
OperationRequestFactory.createFrom(OperationRequest original,
Parameters newParameters)
Creates a new
OperationRequest based on the given original but with
the given newParameters applied. |
Constructor and Description |
---|
StandardOperation(java.lang.String name,
OperationRequest request,
OperationResponse response,
java.util.Map<java.lang.String,java.lang.Object> attributes)
Creates a new
StandardOperation . |
Modifier and Type | Method and Description |
---|---|
OperationRequest |
UriModifyingOperationPreprocessor.preprocess(OperationRequest request) |
OperationRequest |
OperationPreprocessorAdapter.preprocess(OperationRequest request)
Returns the given
request as-is. |
OperationRequest |
ParametersModifyingOperationPreprocessor.preprocess(OperationRequest request) |
OperationRequest |
ContentModifyingOperationPreprocessor.preprocess(OperationRequest request) |
OperationRequest |
OperationPreprocessor.preprocess(OperationRequest request)
Processes the given
request . |
OperationRequest |
OperationRequestPreprocessor.preprocess(OperationRequest request)
Processes and potentially modifies the given
request before it is
documented. |
Modifier and Type | Method and Description |
---|---|
OperationRequest |
UriModifyingOperationPreprocessor.preprocess(OperationRequest request) |
OperationRequest |
OperationPreprocessorAdapter.preprocess(OperationRequest request)
Returns the given
request as-is. |
OperationRequest |
ParametersModifyingOperationPreprocessor.preprocess(OperationRequest request) |
OperationRequest |
ContentModifyingOperationPreprocessor.preprocess(OperationRequest request) |
OperationRequest |
OperationPreprocessor.preprocess(OperationRequest request)
Processes the given
request . |
OperationRequest |
OperationRequestPreprocessor.preprocess(OperationRequest request)
Processes and potentially modifies the given
request before it is
documented. |