Uses of Interface
org.springframework.restdocs.operation.Operation
Packages that use 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.
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.
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.
-
Uses of Operation in org.springframework.restdocs.cli
Methods in org.springframework.restdocs.cli with parameters of type OperationModifier and TypeMethodDescriptionCurlRequestSnippet.createModel(Operation operation) HttpieRequestSnippet.createModel(Operation operation) -
Uses of Operation in org.springframework.restdocs.cookies
Methods in org.springframework.restdocs.cookies with parameters of type OperationModifier and TypeMethodDescriptionAbstractCookiesSnippet.createModel(Operation operation) AbstractCookiesSnippet.extractActualCookies(Operation operation) Extracts the names of the cookies from the request or response of the givenoperation.RequestCookiesSnippet.extractActualCookies(Operation operation) ResponseCookiesSnippet.extractActualCookies(Operation operation) -
Uses of Operation in org.springframework.restdocs.headers
Methods in org.springframework.restdocs.headers with parameters of type OperationModifier and TypeMethodDescriptionAbstractHeadersSnippet.createModel(Operation operation) AbstractHeadersSnippet.extractActualHeaders(Operation operation) Extracts the names of the headers from the request or response of the givenoperation.RequestHeadersSnippet.extractActualHeaders(Operation operation) 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 OperationModifier and TypeMethodDescriptionHttpRequestSnippet.createModel(Operation operation) HttpResponseSnippet.createModel(Operation operation) -
Uses of Operation in org.springframework.restdocs.hypermedia
Methods in org.springframework.restdocs.hypermedia with parameters of type Operation -
Uses of Operation in org.springframework.restdocs.operation
Classes in org.springframework.restdocs.operation that implement Operation -
Uses of Operation in org.springframework.restdocs.payload
Methods in org.springframework.restdocs.payload with parameters of type OperationModifier and TypeMethodDescriptionAbstractBodySnippet.createModel(Operation operation) AbstractFieldsSnippet.createModel(Operation operation) protected abstract byte[]AbstractBodySnippet.getContent(Operation operation) Returns the content of the request or response extracted from the givenoperation.protected abstract byte[]AbstractFieldsSnippet.getContent(Operation operation) Returns the content of the request or response extracted form the givenoperation.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.MediaTypeAbstractBodySnippet.getContentType(Operation operation) Returns the content type of the request or response extracted from the givenoperation.protected abstract org.springframework.http.MediaTypeAbstractFieldsSnippet.getContentType(Operation operation) Returns the content type of the request or response extracted from the givenoperation.protected org.springframework.http.MediaTypeRequestBodySnippet.getContentType(Operation operation) protected org.springframework.http.MediaTypeRequestFieldsSnippet.getContentType(Operation operation) protected org.springframework.http.MediaTypeRequestPartBodySnippet.getContentType(Operation operation) protected org.springframework.http.MediaTypeRequestPartFieldsSnippet.getContentType(Operation operation) protected org.springframework.http.MediaTypeResponseBodySnippet.getContentType(Operation operation) protected org.springframework.http.MediaTypeResponseFieldsSnippet.getContentType(Operation operation) -
Uses of Operation in org.springframework.restdocs.request
Methods in org.springframework.restdocs.request with parameters of type OperationModifier and TypeMethodDescriptionAbstractParametersSnippet.createModel(Operation operation) PathParametersSnippet.createModel(Operation operation) RequestPartsSnippet.createModel(Operation operation) AbstractParametersSnippet.extractActualParameters(Operation operation) Extracts the names of the parameters that were present in the givenoperation.PathParametersSnippet.extractActualParameters(Operation operation) RequestParametersSnippet.extractActualParameters(Operation operation) -
Uses of Operation in org.springframework.restdocs.snippet
Methods in org.springframework.restdocs.snippet with parameters of type OperationModifier and TypeMethodDescriptionTemplatedSnippet.createModel(Operation operation) Create the model that should be used during template rendering to document the givenoperation.voidDocuments the call to the RESTful API described by the givenoperation.void