Package | Description |
---|---|
org.springframework.restdocs.cli |
Documenting CLI commands required to make a request to a RESTful API.
|
org.springframework.restdocs.generate |
Classes that drive the generation of the documentation snippets.
|
org.springframework.restdocs.headers |
Documenting the headers of a RESTful API's requests and responses.
|
org.springframework.restdocs.http |
Documenting the HTTP request sent to a RESTful API and the HTTP response that is
returned.
|
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.
|
org.springframework.restdocs.payload |
Documenting the payload of a RESTful API's requests and responses.
|
org.springframework.restdocs.request |
Documenting query and path parameters of requests sent to a RESTful API.
|
org.springframework.restdocs.snippet |
Snippet generation.
|
Class and Description |
---|
Operation
Describes an operation performed on a RESTful service.
|
Class and Description |
---|
RequestConverter
A
RequestConverter is used to convert an implementation-specific request into
an OperationRequest . |
ResponseConverter
A
ResponseConverter is used to convert an implementation-specific response into
an OperationResponse . |
Class and Description |
---|
Operation
Describes an operation performed on a RESTful service.
|
Class and Description |
---|
Operation
Describes an operation performed on a RESTful service.
|
Class and Description |
---|
Operation
Describes an operation performed on a RESTful service.
|
OperationResponse
The response that was received as part of performing an operation on a RESTful service.
|
Class and Description |
---|
Operation
Describes an operation performed on a RESTful service.
|
OperationRequest
The request that was sent as part of performing an operation on a RESTful service.
|
OperationRequestPart
A part of a multipart request.
|
OperationResponse
The response that was received as part of performing an operation on a RESTful service.
|
Parameters
The parameters received in a request.
|
RequestCookie
A representation of a Cookie received in a request.
|
Class and Description |
---|
OperationRequest
The request that was sent as part of performing an operation on a RESTful service.
|
OperationResponse
The response that was received as part of performing an operation on a RESTful service.
|
Class and Description |
---|
Operation
Describes an operation performed on a RESTful service.
|
Class and Description |
---|
Operation
Describes an operation performed on a RESTful service.
|
Class and Description |
---|
Operation
Describes an operation performed on a RESTful service.
|