Uses of Package
org.springframework.restdocs.operation
Package
Description
Documenting CLI commands required to make a request to a RESTful API.
Documenting the cookies of a RESTful API's requests and responses.
Classes that drive the generation of the documentation snippets.
Documenting the headers of a RESTful API's requests and responses.
Documenting the HTTP request sent to a RESTful API and the HTTP response that is
returned.
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.
Documenting the payload of a RESTful API's requests and responses.
Documenting query and path parameters of requests sent to a RESTful API.
Snippet generation.
-
-
-
ClassDescriptionA
RequestConverter
is used to convert an implementation-specific request into anOperationRequest
.AResponseConverter
is used to convert an implementation-specific response into anOperationResponse
. -
-
-
ClassDescriptionDescribes an operation performed on a RESTful service.The response that was received as part of performing an operation on a RESTful service.
-
ClassDescriptionA request's form parameters, derived from its form URL encoded body content.Describes an operation performed on a RESTful service.The request that was sent as part of performing an operation on a RESTful service.A part of a multipart request.The response that was received as part of performing an operation on a RESTful service.A request's query parameters, derived from its URI's query string.A representation of a Cookie received in a request.A representation of a Cookie returned in a response.
-
ClassDescriptionThe request that was sent as part of performing an operation on a RESTful service.The response that was received as part of performing an operation on a RESTful service.
-
-
-