Uses of Interface
org.springframework.restdocs.operation.Operation

Packages that use Operation

Package	Description
org.springframework.restdocs.cli	Documenting CLI commands required to make a request to a RESTful API.
org.springframework.restdocs.cookies	Documenting the cookies of a RESTful API's requests and responses.
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.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.

Uses of Operation in org.springframework.restdocs.cli

Methods in org.springframework.restdocs.cli with parameters of type Operation

Modifier and Type	Method	Description
protected Map<String,Object>	CurlRequestSnippet.createModel(Operation operation)
protected Map<String,Object>	HttpieRequestSnippet.createModel(Operation operation)

Uses of Operation in org.springframework.restdocs.cookies

Methods in org.springframework.restdocs.cookies with parameters of type Operation

Modifier and Type	Method	Description
protected Map<String,Object>	AbstractCookiesSnippet.createModel(Operation operation)
protected abstract Set<String>	AbstractCookiesSnippet.extractActualCookies(Operation operation)	Extracts the names of the cookies from the request or response of the given operation.
protected Set<String>	RequestCookiesSnippet.extractActualCookies(Operation operation)
protected Set<String>	ResponseCookiesSnippet.extractActualCookies(Operation operation)

Uses of Operation in org.springframework.restdocs.headers

Methods in org.springframework.restdocs.headers with parameters of type Operation

Modifier and Type	Method	Description
protected Map<String,Object>	AbstractHeadersSnippet.createModel(Operation operation)
protected abstract Set<String>	AbstractHeadersSnippet.extractActualHeaders(Operation operation)	Extracts the names of the headers from the request or response of the given operation.
protected Set<String>	RequestHeadersSnippet.extractActualHeaders(Operation operation)
protected Set<String>	ResponseHeadersSnippet.extractActualHeaders(Operation operation)
protected List<HeaderDescriptor>	AbstractHeadersSnippet.findMissingHeaders(Operation operation)	Finds the headers that are missing from the operation.

Uses of Operation in org.springframework.restdocs.http

Methods in org.springframework.restdocs.http with parameters of type Operation

Modifier and Type	Method	Description
protected Map<String,Object>	HttpRequestSnippet.createModel(Operation operation)
protected Map<String,Object>	HttpResponseSnippet.createModel(Operation operation)

Uses of Operation in org.springframework.restdocs.hypermedia

Methods in org.springframework.restdocs.hypermedia with parameters of type Operation

Modifier and Type	Method	Description
protected Map<String,Object>	LinksSnippet.createModel(Operation operation)

Uses of Operation in org.springframework.restdocs.operation

Classes in org.springframework.restdocs.operation that implement Operation

Modifier and Type	Class	Description
class	StandardOperation	Standard implementation of Operation.

Uses of Operation in org.springframework.restdocs.payload

Methods in org.springframework.restdocs.payload with parameters of type Operation

Modifier and Type	Method	Description
protected Map<String,Object>	AbstractBodySnippet.createModel(Operation operation)
protected Map<String,Object>	AbstractFieldsSnippet.createModel(Operation operation)
protected abstract byte[]	AbstractBodySnippet.getContent(Operation operation)	Returns the content of the request or response extracted from the given operation.
protected abstract byte[]	AbstractFieldsSnippet.getContent(Operation operation)	Returns the content of the request or response extracted form the given operation.
protected byte[]	RequestBodySnippet.getContent(Operation operation)
protected byte[]	RequestFieldsSnippet.getContent(Operation operation)
protected byte[]	RequestPartBodySnippet.getContent(Operation operation)
protected byte[]	RequestPartFieldsSnippet.getContent(Operation operation)
protected byte[]	ResponseBodySnippet.getContent(Operation operation)
protected byte[]	ResponseFieldsSnippet.getContent(Operation operation)
protected abstract org.springframework.http.MediaType	AbstractBodySnippet.getContentType(Operation operation)	Returns the content type of the request or response extracted from the given operation.
protected abstract org.springframework.http.MediaType	AbstractFieldsSnippet.getContentType(Operation operation)	Returns the content type of the request or response extracted from the given operation.
protected org.springframework.http.MediaType	RequestBodySnippet.getContentType(Operation operation)
protected org.springframework.http.MediaType	RequestFieldsSnippet.getContentType(Operation operation)
protected org.springframework.http.MediaType	RequestPartBodySnippet.getContentType(Operation operation)
protected org.springframework.http.MediaType	RequestPartFieldsSnippet.getContentType(Operation operation)
protected org.springframework.http.MediaType	ResponseBodySnippet.getContentType(Operation operation)
protected org.springframework.http.MediaType	ResponseFieldsSnippet.getContentType(Operation operation)

Uses of Operation in org.springframework.restdocs.request

Methods in org.springframework.restdocs.request with parameters of type Operation

Modifier and Type	Method	Description
protected Map<String,Object>	AbstractParametersSnippet.createModel(Operation operation)
protected Map<String,Object>	PathParametersSnippet.createModel(Operation operation)
protected Map<String,Object>	RequestPartsSnippet.createModel(Operation operation)
protected abstract Set<String>	AbstractParametersSnippet.extractActualParameters(Operation operation)	Extracts the names of the parameters that were present in the given operation.
protected Set<String>	FormParametersSnippet.extractActualParameters(Operation operation)
protected Set<String>	PathParametersSnippet.extractActualParameters(Operation operation)
protected Set<String>	QueryParametersSnippet.extractActualParameters(Operation operation)

Uses of Operation in org.springframework.restdocs.snippet

Methods in org.springframework.restdocs.snippet with parameters of type Operation

Modifier and Type	Method	Description
protected abstract Map<String,Object>	TemplatedSnippet.createModel(Operation operation)	Create the model that should be used during template rendering to document the given operation.
void	Snippet.document(Operation operation)	Documents the call to the RESTful API described by the given operation.
void	TemplatedSnippet.document(Operation operation)