Package | Description |
---|---|
org.springframework.restdocs.hypermedia |
Documenting a RESTful API that uses hypermedia.
|
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 |
---|---|
java.util.Map<java.lang.String,java.util.List<Link>> |
LinkExtractor.extractLinks(OperationResponse response)
Extract the links from the given
response , returning a Map of links
where the keys are the link rels. |
Modifier and Type | Method and Description |
---|---|
OperationResponse |
ResponseConverter.convert(R response)
Converts the given
response into an OperationResponse . |
OperationResponse |
OperationResponseFactory.create(org.springframework.http.HttpStatus status,
org.springframework.http.HttpHeaders headers,
byte[] content)
Deprecated.
since 2.0.4 in favor of
OperationResponseFactory.create(int, HttpHeaders, byte[]) |
OperationResponse |
OperationResponseFactory.create(int status,
org.springframework.http.HttpHeaders headers,
byte[] content) |
OperationResponse |
OperationResponseFactory.createFrom(OperationResponse original,
byte[] newContent)
Creates a new
OperationResponse based on the given original but
with the given newContent . |
OperationResponse |
OperationResponseFactory.createFrom(OperationResponse original,
org.springframework.http.HttpHeaders newHeaders)
Creates a new
OperationResponse based on the given original but
with the given newHeaders . |
OperationResponse |
Operation.getResponse()
Returns the response that was received.
|
OperationResponse |
StandardOperation.getResponse() |
Modifier and Type | Method and Description |
---|---|
OperationResponse |
OperationResponseFactory.createFrom(OperationResponse original,
byte[] newContent)
Creates a new
OperationResponse based on the given original but
with the given newContent . |
OperationResponse |
OperationResponseFactory.createFrom(OperationResponse original,
org.springframework.http.HttpHeaders newHeaders)
Creates a new
OperationResponse based on the given original but
with the given newHeaders . |
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 |
---|---|
OperationResponse |
UriModifyingOperationPreprocessor.preprocess(OperationResponse response) |
OperationResponse |
OperationPreprocessorAdapter.preprocess(OperationResponse response)
Returns the given
response as-is. |
OperationResponse |
OperationResponsePreprocessor.preprocess(OperationResponse response)
Processes and potentially modifies the given
response before it is
documented. |
OperationResponse |
ContentModifyingOperationPreprocessor.preprocess(OperationResponse response) |
OperationResponse |
OperationPreprocessor.preprocess(OperationResponse response)
Processes the given
response . |
Modifier and Type | Method and Description |
---|---|
OperationResponse |
UriModifyingOperationPreprocessor.preprocess(OperationResponse response) |
OperationResponse |
OperationPreprocessorAdapter.preprocess(OperationResponse response)
Returns the given
response as-is. |
OperationResponse |
OperationResponsePreprocessor.preprocess(OperationResponse response)
Processes and potentially modifies the given
response before it is
documented. |
OperationResponse |
ContentModifyingOperationPreprocessor.preprocess(OperationResponse response) |
OperationResponse |
OperationPreprocessor.preprocess(OperationResponse response)
Processes the given
response . |